Yate
|
An abstract call endpoint. More...
#include <yatephone.h>
Public Member Functions | |
virtual void | destroyed () |
virtual void * | getObject (const String &name) const |
virtual const String & | toString () const |
const String & | id () const |
CallEndpoint * | getPeer () const |
bool | getPeerId (String &id) const |
String | getPeerId () const |
Mutex * | mutex () const |
bool | connect (CallEndpoint *peer, const char *reason=0, bool notify=true) |
bool | disconnect (const char *reason=0, bool notify=true, const NamedList *params=0) |
bool | disconnect (const char *reason, const NamedList ¶ms) |
DataEndpoint * | getEndpoint (const char *type="audio") const |
DataEndpoint * | setEndpoint (const char *type="audio") |
void | clearEndpoint (const char *type=0) |
void | setSource (DataSource *source=0, const char *type="audio") |
DataSource * | getSource (const char *type="audio") const |
void | setConsumer (DataConsumer *consumer=0, const char *type="audio") |
DataConsumer * | getConsumer (const char *type="audio") const |
bool | clearData (DataNode *node, const char *type="audio") |
Static Public Member Functions | |
static Mutex & | commonMutex () |
Protected Member Functions | |
CallEndpoint (const char *id=0) | |
virtual void | connected (const char *reason) |
virtual void | disconnected (bool final, const char *reason) |
virtual void | setDisconnect (const NamedList *params) |
void | setPeer (CallEndpoint *peer, const char *reason=0, bool notify=true, const NamedList *params=0) |
void | setEndpoint (DataEndpoint *endPoint) |
virtual void | setId (const char *newId) |
Protected Attributes | |
ObjList | m_data |
Mutex * | m_mutex |
Friends | |
class | DataEndpoint |
An abstract call endpoint.
A class that holds common call control and data related features
CallEndpoint | ( | const char * | id = 0 | ) | [protected] |
Constructor
bool clearData | ( | DataNode * | node, |
const char * | type = "audio" |
||
) |
Clear a data node from any slot of a DataEndpoint of this object
node | Pointer to DataSource or DataConsumer to clear |
type | Type of data node: "audio", "video", "text" |
void clearEndpoint | ( | const char * | type = 0 | ) |
Clear one or all data endpoints of this object
type | Type of data endpoint: "audio", "video", "text", NULL to clear all |
static Mutex& commonMutex | ( | ) | [static] |
Get the big mutex that serializes access to all call endpoints
bool connect | ( | CallEndpoint * | peer, |
const char * | reason = 0 , |
||
bool | notify = true |
||
) |
Connect the call endpoint to a peer.
peer | Pointer to the peer call endpoint. |
reason | Text that describes connect reason. |
notify | Call disconnected() notification method on old peer |
virtual void connected | ( | const char * | reason | ) | [inline, protected, virtual] |
Connect notification method.
reason | Text that describes connect reason. |
Reimplemented in Channel, and ClientChannel.
virtual void destroyed | ( | ) | [virtual] |
Destruct notification, performs cleanups
Reimplemented from RefObject.
Reimplemented in ClientChannel.
bool disconnect | ( | const char * | reason = 0 , |
bool | notify = true , |
||
const NamedList * | params = 0 |
||
) | [inline] |
Disconnect from the connected peer call endpoint.
reason | Text that describes disconnect reason. |
notify | Call disconnected() notification method on old peer |
params | Optional pointer to extra parameters for disconnect cause |
References CallEndpoint::disconnect().
Referenced by CallEndpoint::disconnect().
bool disconnect | ( | const char * | reason, |
const NamedList & | params | ||
) | [inline] |
Disconnect from the connected peer call endpoint and notify old peer.
reason | Text that describes disconnect reason. |
params | Extra parameters for disconnect cause |
References CallEndpoint::disconnect().
Referenced by CallEndpoint::disconnect().
virtual void disconnected | ( | bool | final, |
const char * | reason | ||
) | [inline, protected, virtual] |
Disconnect notification method.
final | True if this disconnect was called from the destructor. |
reason | Text that describes disconnect reason. |
Reimplemented in Channel, and ClientChannel.
DataConsumer* getConsumer | ( | const char * | type = "audio" | ) | const |
Get the data consumer of this object
type | Type of data node: "audio", "video", "text" |
DataEndpoint* getEndpoint | ( | const char * | type = "audio" | ) | const |
Get a data endpoint of this object
type | Type of data endpoint: "audio", "video", "text" |
virtual void* getObject | ( | const String & | name | ) | const [virtual] |
CallEndpoint* getPeer | ( | ) | const [inline] |
Get the connected peer call
bool getPeerId | ( | String & | id | ) | const |
String getPeerId | ( | ) | const |
Get the connected peer call id
DataSource* getSource | ( | const char * | type = "audio" | ) | const |
Get a data source of this object
type | Type of data node: "audio", "video", "text" |
const String& id | ( | ) | const [inline] |
Get the unique channel identifier
Mutex* mutex | ( | ) | const [inline] |
Get the mutex that serializes access to this call endpoint, if any
void setConsumer | ( | DataConsumer * | consumer = 0 , |
const char * | type = "audio" |
||
) |
Set the data consumer of this object
consumer | A pointer to the new consumer or NULL |
type | Type of data node: "audio", "video", "text" |
virtual void setDisconnect | ( | const NamedList * | params | ) | [inline, protected, virtual] |
Set disconnect parameters
params | Pointer to disconnect cause parameters, NULL to reset them |
Reimplemented in Channel.
DataEndpoint* setEndpoint | ( | const char * | type = "audio" | ) |
Get a data endpoint of this object, create if required
type | Type of data endpoint: "audio", "video", "text" |
void setEndpoint | ( | DataEndpoint * | endPoint | ) | [protected] |
Set a foreign data endpoint in this object
endPoint | Data endpoint to set, will replace one with same type |
virtual void setId | ( | const char * | newId | ) | [protected, virtual] |
Set a new ID for this call endpoint
newId | New ID to set to this call |
Reimplemented in Channel.
void setPeer | ( | CallEndpoint * | peer, |
const char * | reason = 0 , |
||
bool | notify = true , |
||
const NamedList * | params = 0 |
||
) | [protected] |
Set the peer call endpoint pointer.
peer | A pointer to the new peer or NULL. |
reason | Text describing the reason in case of disconnect. |
notify | Call notification methods - connected() or disconnected() |
params | Optional pointer to extra parameters for disconnect cause |
void setSource | ( | DataSource * | source = 0 , |
const char * | type = "audio" |
||
) |
Set a data source of this object
source | A pointer to the new source or NULL |
type | Type of data node: "audio", "video", "text" |
virtual const String& toString | ( | ) | const [inline, virtual] |
Get a string representation of this channel
Reimplemented from GenObject.