MGCPEndpointId Class Reference

An endpoint id. More...

#include <yatemgcp.h>

Inheritance diagram for MGCPEndpointId:

MGCPEndpoint MGCPEpInfo

List of all members.

Public Member Functions

 MGCPEndpointId ()
 MGCPEndpointId (String &src)
 MGCPEndpointId (const char *endpoint, const char *host, int port)
const Stringid () const
const Stringuser () const
const Stringhost () const
int port () const
void port (int newPort)
void set (const char *endpoint, const char *host, int port)
void set (String &src)
bool valid () const


Detailed Description

An endpoint id.

This class holds an endpoint id in the form "endpoint@host:port"


Constructor & Destructor Documentation

MGCPEndpointId (  )  [inline]

Constructor

MGCPEndpointId ( String src  )  [inline]

Constructor. Construct this endpoint id from a string

Parameters:
src The string to construct from

MGCPEndpointId ( const char *  endpoint,
const char *  host,
int  port 
) [inline]

Constructor. Construct this endpoint id

Parameters:
endpoint The user part of the endpoint's URI
host The IP address of the endpoint's URI
port The port used by the endpoint to receive data


Member Function Documentation

const String& id (  )  const [inline]

Get the full id of the endpoint

Returns:
The full id of the endpoint

Referenced by MGCPEndpoint::toString().

const String& user (  )  const [inline]

Get the user part of the endpoint URI

Returns:
The user part of the endpoint URI

const String& host (  )  const [inline]

Get the host part of the endpoint URI

Returns:
The host part of the endpoint URI

int port (  )  const [inline]

Get the port used by this endpoint

Returns:
The port used by this endpoint

void port ( int  newPort  )  [inline]

Set the port used by this endpoint

Parameters:
newPort The new port used by this endpoint

void set ( const char *  endpoint,
const char *  host,
int  port 
)

Set this endpoint id. Convert it to lower case

Parameters:
endpoint The user part of the endpoint's URI
host The IP address of the endpoint's URI
port The port used by the endpoint to receive data

void set ( String src  )  [inline]

Set this endpoint id. Convert it to lower case

Parameters:
src The string to construct from

References URI::getHost(), URI::getPort(), and URI::getUser().

bool valid (  )  const [inline]

Check if this is a valid endpoint id as defined in RFC 3435 3.2.1.3. It is considerred valid if the user and host part lengths are between 1 and 255 and the port is not 0

Returns:
True if this is a valid endpoint id


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

Generated on Mon Aug 11 16:17:54 2008 for Yate by  doxygen 1.5.6