namespace lmsg class NameClient : private AppClient

Name service client API.

Inheritance:

Public Methods

virtual	~NameClient (void) Destructor.
	NameClient (void) Construct a client.
const char*	getDomain (void) const get the Domain name.
void	setDebug (index_type level) Set the client interface debug level
error_type	setDomain (const char* domain) Set the name server port address.
error_type	addName (const char* name, const MsgAddr& addr, NameProcs Type=p_Any) Add a name.
error_type	addName (const NameData& name) Add a name.
error_type	getIndex (std::string& list, MsgAddr::ipaddr_t addr=0, NameProcs Type=p_Any) Get a list of names.
error_type	remName (const char* name) Remove a name.
error_type	remName (const NameData& name) Remove a name.
error_type	lookup (const char* name, MsgAddr& addr) find a name.
error_type	lookup (const char* name, NameData& msg) find a name.
error_type	lookupID (int ident, MsgAddr& addr) find a name.
error_type	lookupID (int ident, NameData& msg) find a name.

Inherited from AppClient:

Public Methods

error_type request(const MsgAddr& to, const Message& req, MsgHeader& hdr, char* data, index_type length)

error_type request(const MsgHeader& ReqHdr, const void* ReqData, MsgHeader& hdr, char* data, index_type length)

error_type request(const MsgAddr& to, const Message& Req, Message& Reply)

error_type request(const MsgAddr& to, const Message& Req, MsgHeader& RepHdr, Message& Reply)

error_type getDebug(void) const

error_type getRetry(void) const

wtime_type getTimeOut(void) const

bool isOpen(void) const

void setBufferPool(BufferPool* pool)

void setRetry(index_type n)

void setTimeOut(wtime_type time)

void setSocketPool(SocketPool* pool)

virtual ~NameClient(void)

Release the port and the client sattus information.

NameClient(void)

Create a client object. Get the default name server (domain) address from the DMTNAMESERVER environment variable.

const char* getDomain(void) const

Get the current name server (domain) IP host name.

void setDebug(index_type level)

Set the client interface debug level. @set the debug level.

error_type setDomain(const char* domain)

Provide a name server port adddress in the form "<ip-node>:<port>", where <ip-node> is an IP node name, and <port> is a vlid port number.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

domain - Node and port number specified as descibed above.

error_type addName(const char* name, const MsgAddr& addr, NameProcs Type=p_Any)

Request the server to add a name to its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - Name to be added to the dictionary
addr - Address corresponding to the name.
ptype - Process type of the added name.

error_type addName(const NameData& name)

Request the server to add a name to its dictionary. All information pertining to the process is encoded in a NameMsg object.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - NameMsg with information to be added to the dictionary

error_type getIndex(std::string& list, MsgAddr::ipaddr_t addr=0, NameProcs Type=p_Any)

Request a list of server names from the dictionary. The names are optionally selected by process type and ip node.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - List of selected names from the dictionary
addr - IP address for names.
ptype - Process types.

error_type remName(const char* name)

Request the server to remove a name from its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - Name to be removed from the dictionary

error_type remName(const NameData& name)

Request the server to remove a name from its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - NameMsg with name to be removed from the dictionary

error_type lookup(const char* name, MsgAddr& addr)

Request the server to look-up a name in its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - Name to be found in the dictionary
addr - MsgAddr to receive the address of the named process.

error_type lookup(const char* name, NameData& msg)

Request the server to look-up a name in its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

name - Name to be found in the dictionary
addr - MsgAddr to receive the requested information.

error_type lookupID(int ident, MsgAddr& addr)

Request the server to look-up an entry in its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

ident - Server ID to be found in the dictionary
addr - MsgAddr to receive the address of the named process.

error_type lookupID(int ident, NameData& msg)

Request the server to look-up an entry in its dictionary.

Returns:

Error status (as described in ErrorList.hh)

Parameters:

ident - Server ID to be found in the dictionary
addr - MsgAddr to receive the requested information.

This class has no child classes.

Author:

John Zweizig

Version:

1.0; Modfied January 28, 2000

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++