class MGCPEndpointId

An endpoint id. More...

Full nameTelEngine::MGCPEndpointId
Definition#include <libs/ymgcp/yatemgcp.h>
Inherited byMGCPEndpoint, MGCPEpInfo
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

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

inline  MGCPEndpointId ()

MGCPEndpointId

Constructor

inline  MGCPEndpointId (const String& src)

MGCPEndpointId

Constructor. Construct this endpoint id from a string

Parameters:
srcThe string to construct from

inline  MGCPEndpointId (const MGCPEndpointId& value)

MGCPEndpointId

Copy constructor

Parameters:
valueOriginal Endpoint ID to copy

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

MGCPEndpointId

Constructor. Construct this endpoint id

Parameters:
endpointThe user part of the endpoint's URI
hostThe IP address of the endpoint's URI
portThe port used by the endpoint to receive data

inline const String&  id ()

id

[const]

Get the full id of the endpoint

Returns: The full id of the endpoint

inline const String&  user ()

user

[const]

Get the user part of the endpoint URI

Returns: The user part of the endpoint URI

inline const String&  host ()

host

[const]

Get the host part of the endpoint URI

Returns: The host part of the endpoint URI

inline int  port ()

port

[const]

Get the port used by this endpoint

Returns: The port used by this endpoint

inline void  port (int newPort)

port

Set the port used by this endpoint

Parameters:
newPortThe new port used by this endpoint

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

set

Set this endpoint id. Convert it to lower case

Parameters:
endpointThe user part of the endpoint's URI
hostThe IP address of the endpoint's URI
portThe port used by the endpoint to receive data

inline void  set (const String& src)

set

Set this endpoint id. Convert it to lower case

Parameters:
srcThe string to construct from

inline bool  valid ()

valid

[const]

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


Generated by: paulc on bussard on Tue Apr 12 17:15:21 2011, using kdoc 2.0a54.