Yate
Public Member Functions | Public Attributes
MGCPEpInfo Class Reference

Remote endpoint info class. More...

#include <yatemgcp.h>

Inheritance diagram for MGCPEpInfo:
MGCPEndpointId GenObject

List of all members.

Public Member Functions

 MGCPEpInfo (const char *endpoint, const char *host, int port, bool addPort=true)
virtual const StringtoString () const
const SocketAddraddress () const
const SocketAddraddress ()
void address (const SocketAddr &addr)

Public Attributes

String alias

Detailed Description

Remote endpoint info class.

This class holds data about a remote endpoint (id and address)


Constructor & Destructor Documentation

MGCPEpInfo ( const char *  endpoint,
const char *  host,
int  port,
bool  addPort = true 
) [inline]

Constructor. Construct this endpoint info

Parameters:
endpointThe endpoint part of the endpoint's id
hostThe IP address of this endpoint
portThe port used to send data to this endpoint
addPortAdd :port at end of id only if port is not zero

References MGCPEndpointId::port().


Member Function Documentation

const SocketAddr& address ( ) const [inline]

Retrieve the current address for this endpoint information

Returns:
Address and port of this endpoint info
const SocketAddr& address ( )

Retrieve the address for this endpoint information, resolve name if needed

Returns:
Address and port of this endpoint info
void address ( const SocketAddr addr) [inline]

Set a new socket address in the endpoint info

Parameters:
addrNew address and port to set in the endpoint
virtual const String& toString ( ) const [inline, virtual]

Get a string representation of this object

Returns:
The endpoint's id

Reimplemented from GenObject.


Member Data Documentation

An alias name of the remote endpoint, may be empty


The documentation for this class was generated from the following file: