Yate
Public Member Functions
MGCPEndpoint Class Reference

An MGCP endpoint. More...

#include <yatemgcp.h>

Inheritance diagram for MGCPEndpoint:
RefObject MGCPEndpointId Mutex GenObject Lockable

List of all members.

Public Member Functions

 MGCPEndpoint (MGCPEngine *engine, const char *user, const char *host, int port, bool addPort=true)
virtual ~MGCPEndpoint ()
virtual const StringtoString () const
MGCPEngineengine ()
MGCPEpInfoappend (const char *endpoint, const char *host, int port=0)
void clear ()
MGCPEpInfofind (const String &epId)
MGCPEpInfofindAlias (const String &alias)
MGCPEpInfopeer ()

Detailed Description

An MGCP endpoint.

This class holds a local MGCP endpoint (either gateway or call agent) along with its remote peer(s). If the engine owning this endpoint is an MGCP gateway, only 1 remote peer (Call Agent) is allowed


Constructor & Destructor Documentation

MGCPEndpoint ( MGCPEngine engine,
const char *  user,
const char *  host,
int  port,
bool  addPort = true 
)

Constructor. Construct this endpoint. Append itself to the engine's list. The endpoint's id will be created from the received user and engine's address

Parameters:
engineThe engine owning this endpoint
userThe user part of the endpoint's id
hostThe host part of the endpoint's id
portThe port part of the endpoint's id
addPortAdd :port at end of id only if port is not zero
virtual ~MGCPEndpoint ( ) [virtual]

Destructor. Remove itself from engine's list


Member Function Documentation

MGCPEpInfo* append ( const char *  endpoint,
const char *  host,
int  port = 0 
)

Append info about a remote endpoint controlled by or controlling this endpoint. If the engine owning this endpoint is an MGCP gateway, only 1 remote peer (Call Agent) is allowed

Parameters:
endpointThe endpoint part of the remote endpoint's id
hostThe IP address of the remote endpoint
portThe port used to send data to this endpoint. Set to 0 to set it to the default port defined by the protocol and the opposite of the engine's mode A value of -1 uses the default but doesn't add :port at end of ID Other negative values use specified port but don't add :port at end
Returns:
Valid MGCPEpInfo pointer or 0 if the data wasn't added
void clear ( ) [inline]

Clear the list or remote endpoints

MGCPEngine* engine ( ) [inline]

Get the engine owning this endpoint

Returns:
The engine owning this endpoint
MGCPEpInfo* find ( const String epId)

Find the info object associated with a remote peer

Parameters:
epIdThe remote endpoint's id to find
Returns:
MGCPEpInfo pointer or 0 if not found
MGCPEpInfo* findAlias ( const String alias)

Find an info object by remote peer alias

Parameters:
aliasAlias of the remote endpoint's id to find
Returns:
MGCPEpInfo pointer or 0 if not found

Find the info object associated with an unique remote peer

Returns:
MGCPEpInfo pointer or 0 if not exactly one peer
virtual const String& toString ( ) const [inline, virtual]

Get a string representation of this endpoint

Returns:
A string representation of this endpoint

Reimplemented from GenObject.

References MGCPEndpointId::id().


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