|
|
A class that holds common call control and data related features
ObjList m_data | m_data |
[protected]
Mutex* m_mutex | m_mutex |
[protected]
~CallEndpoint ()
| ~CallEndpoint |
[virtual]
Destructor
void* getObject (const String& name)
| getObject |
[const virtual]
Get a pointer to a derived class given that class name
Parameters:
name | Name of the class we are asking for |
Returns: Pointer to the requested class or NULL if this object doesn't implement it
Reimplemented from GenObject.
const String& toString ()
| toString |
[const virtual]
Get a string representation of this channel
Returns: A reference to the name of this object
Reimplemented from GenObject.
inline const String& id ()
| id |
[const]
Get the unique channel identifier
Returns: A String holding the unique channel id
inline CallEndpoint* getPeer ()
| getPeer |
[const]
Get the connected peer call
Returns: Pointer to connected peer call or NULL
inline const String& getPeerId ()
| getPeerId |
[const]
Get the connected peer call id
Returns: Connected peer call id or empty string
inline Mutex* mutex ()
| mutex |
[const]
Get the mutex that serializes access to this call endpoint, if any
Returns: Pointer to the call's mutex object or NULL
Mutex& commonMutex ()
| commonMutex |
[static]
Get the big mutex that serializes access to all call endpoints
Returns: A reference to the mutex
bool connect (CallEndpoint* peer, const char* reason = 0, bool notify = true)
| connect |
Connect the call endpoint to a peer.
Parameters:
peer | Pointer to the peer call endpoint. |
reason | Text that describes connect reason. |
notify | Call disconnected() notification method on old peer |
Returns: True if connected, false if an error occured.
inline bool disconnect (const char* reason = 0, bool notify = true)
| disconnect |
Disconnect from the connected peer call endpoint.
Parameters:
reason | Text that describes disconnect reason. |
notify | Call disconnected() notification method on old peer |
Returns: True if the object was deleted, false if it still exists
DataEndpoint* getEndpoint (const char* type = "audio")
| getEndpoint |
[const]
Get a data endpoint of this object
Parameters:
type | Type of data endpoint: "audio", "video", "text" |
Returns: A pointer to the DataEndpoint object or NULL if not found
DataEndpoint* setEndpoint (const char* type = "audio")
| setEndpoint |
Get a data endpoint of this object, create if required
Parameters:
type | Type of data endpoint: "audio", "video", "text" |
Returns: A pointer to the DataEndpoint object or NULL if an error occured
void clearEndpoint (const char* type = 0)
| clearEndpoint |
Clear one or all data endpoints of this object
Parameters:
type | Type of data endpoint: "audio", "video", "text", NULL to clear all |
void setSource (DataSource* source = 0, const char* type = "audio")
| setSource |
Set a data source of this object
Parameters:
source | A pointer to the new source or NULL |
type | Type of data node: "audio", "video", "text" |
DataSource* getSource (const char* type = "audio")
| getSource |
[const]
Get a data source of this object
Parameters:
type | Type of data node: "audio", "video", "text" |
Returns: A pointer to the DataSource object or NULL
void setConsumer (DataConsumer* consumer = 0, const char* type = "audio")
| setConsumer |
Set the data consumer of this object
Parameters:
consumer | A pointer to the new consumer or NULL |
type | Type of data node: "audio", "video", "text" |
DataConsumer* getConsumer (const char* type = "audio")
| getConsumer |
[const]
Get the data consumer of this object
Parameters:
type | Type of data node: "audio", "video", "text" |
Returns: A pointer to the DataConsumer object or NULL
CallEndpoint (const char* id = 0)
| CallEndpoint |
[protected]
Constructor
void connected (const char* reason)
| connected |
[protected virtual]
Connect notification method.
Parameters:
reason | Text that describes connect reason. |
void disconnected (bool final, const char* reason)
| disconnected |
[protected virtual]
Disconnect notification method.
Parameters:
final | True if this disconnect was called from the destructor. |
reason | Text that describes disconnect reason. |
void setPeer (CallEndpoint* peer, const char* reason = 0, bool notify = true)
| setPeer |
[protected]
Set the peer call endpoint pointer.
Parameters:
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() |
void setEndpoint (DataEndpoint* endPoint)
| setEndpoint |
[protected]
Set a foreign data endpoint in this object
Parameters:
endPoint | Data endpoint to set, will replace one with same type |
void setId (const char* newId)
| setId |
[protected virtual]
Set a new ID for this call endpoint
Parameters:
newId | New ID to set to this call |
Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54. |