class MgcDeleteConnectionAgent : public MgcCommand

This message is sent from the agen to the gateway to end a call

Inheritance:


Public Methods

bool addDetectEvents(const MgcRequestedEvent& parameter)
Add list of ents that have been detected
bool addRequestedEvents(const MgcRequestedEvent& parameter)
Add an event that we wish to be notified about
bool addSignalRequests(const MgcSignalEvent& parameter)
Add a signal that we wish the gateway to produce
void clearDetectEvents()
Clear the list of detected events that have been added to this message
void clearRequestedEvents()
Clear the list of signals that have added to this message
void clearSignalRequests()
Clear the list of signals that have added to this message
MgcCommand* copy()
make a copy of the MgCommand of the appropriate type
MgcpCommand* getDataPtr()
Get pointer to object holding data. This function is used internally by the stack. users of the stack should never call it.
string getEndpointId()
Get endpoint that created the notification
int getResponseCode()
Get the response error code
string getResponseString()
Get the description of any response error
MgcCommandType getType()
Get the type of the command
MgcDeleteConnectionAgent(const string& EndpointId)
message to delete the call at the specified endpoint
MgcDeleteConnectionAgent(const MgcDeleteConnectionAgent& x)
MgcDeleteConnectionAgent(MgcpCommand* x)
this function is used by the stack
bool setBearerInformation(const MgcpBearerInformation& parameter)
Set the optional bearer information
void setCallId(const string& parameter)
Specify the call id
void setConnectionId(const string& parameter)
specify the connection id
bool setDigitMap(const string& parameter)
Specifiy a digimap for the gateway to collect
bool setNotifiedEntity(const string& parameter)
Set who should be notified about events
bool setQuarantineHandling(MgcpNotificationHandling handling, MgcpQuarantineTreatment treatment)
Specify how to deal with quarantined events
bool setRequestIdentifier(const string& parameter)
Set the optional request identifier
void setResponseAck(const string& parameter)
this function will be handled automatically in future versions by the stack

Public

Get parameters describing actual connection
Specify why the call is being ended

Private Fields

Sptr data
Holds the data for this command

Inherited from MgcCommand:

Public Methods

MgcpCommand* getResponsePtr()
Sptr getResponseSptr()
void setResponsePtr(MgcpResponse* p)
void setResponseSptr(const Sptr& p)

Protected Fields

Sptr responseMsg

Documentation

This message is sent from the agen to the gateway to end a call
MgcDeleteConnectionAgent(const string& EndpointId)
message to delete the call at the specified endpoint

MgcDeleteConnectionAgent(const MgcDeleteConnectionAgent& x)

MgcDeleteConnectionAgent(MgcpCommand* x)
this function is used by the stack. Stack users should never call it, as it will probably disappear by the next version.

MgcCommand* copy()
make a copy of the MgCommand of the appropriate type

MgcCommandType getType()
Get the type of the command

MgcpCommand* getDataPtr()
Get pointer to object holding data. This function is used internally by the stack. users of the stack should never call it.

void setResponseAck(const string& parameter)
this function will be handled automatically in future versions by the stack. users of the stack should never call it.

bool setBearerInformation(const MgcpBearerInformation& parameter)
Set the optional bearer information

void setCallId(const string& parameter)
Specify the call id

void setConnectionId(const string& parameter)
specify the connection id

bool setRequestIdentifier(const string& parameter)
Set the optional request identifier

bool addRequestedEvents(const MgcRequestedEvent& parameter)
Add an event that we wish to be notified about

void clearRequestedEvents()
Clear the list of signals that have added to this message

bool addSignalRequests(const MgcSignalEvent& parameter)
Add a signal that we wish the gateway to produce

void clearSignalRequests()
Clear the list of signals that have added to this message

bool setNotifiedEntity(const string& parameter)
Set who should be notified about events

Specify why the call is being ended

bool setDigitMap(const string& parameter)
Specifiy a digimap for the gateway to collect

bool setQuarantineHandling(MgcpNotificationHandling handling, MgcpQuarantineTreatment treatment)
Specify how to deal with quarantined events

bool addDetectEvents(const MgcRequestedEvent& parameter)
Add list of ents that have been detected

void clearDetectEvents()
Clear the list of detected events that have been added to this message

Get parameters describing actual connection

int getResponseCode()
Get the response error code

string getResponseString()
Get the description of any response error

string getEndpointId()
Get endpoint that created the notification

Sptr data
Holds the data for this command


This class has no child classes.

alphabetic index hierarchy of classes


generated by doc++