| Yate
    | 
A data transfer endpoint capable of sending and/or receiving data. More...
#include <yatephone.h>
 
  
| Public Member Functions | |
| DataEndpoint (CallEndpoint *call=0, const char *name="audio") | |
| virtual void | destroyed () | 
| virtual void * | getObject (const String &name) const | 
| virtual const String & | toString () const | 
| Mutex * | mutex () const | 
| bool | connect (DataEndpoint *peer) | 
| bool | disconnect () | 
| void | setSource (DataSource *source=0) | 
| DataSource * | getSource () const | 
| void | setConsumer (DataConsumer *consumer=0) | 
| DataConsumer * | getConsumer () const | 
| void | setPeerRecord (DataConsumer *consumer=0) | 
| DataConsumer * | getPeerRecord () const | 
| void | setCallRecord (DataConsumer *consumer=0) | 
| DataConsumer * | getCallRecord () const | 
| bool | clearData (DataNode *node) | 
| bool | addSniffer (DataConsumer *sniffer) | 
| bool | delSniffer (DataConsumer *sniffer) | 
| DataConsumer * | getSniffer (const String &name, bool ref=false) | 
| void | clearSniffers () | 
| DataEndpoint * | getPeer () const | 
| CallEndpoint * | getCall () const | 
| const String & | name () const | 
| void | clearCall (const CallEndpoint *call) | 
| virtual bool | control (NamedList ¶ms) | 
|  Public Member Functions inherited from RefObject | |
| RefObject () | |
| virtual | ~RefObject () | 
| virtual bool | alive () const | 
| bool | ref () | 
| bool | deref () | 
| int | refcount () const | 
| virtual void | destruct () | 
|  Public Member Functions inherited from GenObject | |
| GenObject () | |
| virtual | ~GenObject () | 
| virtual const String & | traceId () const | 
| NamedCounter * | getObjCounter () const | 
| NamedCounter * | setObjCounter (NamedCounter *counter) | 
| Static Public Member Functions | |
| static Mutex & | commonMutex () | 
|  Static Public Member Functions inherited from RefObject | |
| static bool | alive (const RefObject *obj) | 
| static bool | efficientIncDec () | 
|  Static Public Member Functions inherited from GenObject | |
| static void * | getObject (const String &name, const GenObject *obj) | 
| static bool | getObjCounting () | 
| static void | setObjCounting (bool enable) | 
| static NamedCounter * | getObjCounter (const String &name, bool create=true) | 
| static ObjList & | getObjCounters () | 
| Protected Member Functions | |
| virtual bool | nativeConnect (DataEndpoint *peer) | 
|  Protected Member Functions inherited from RefObject | |
| virtual void | zeroRefs () | 
| bool | resurrect () | 
A data transfer endpoint capable of sending and/or receiving data.
The DataEndpoint holds an endpoint capable of performing unidirectional or bidirectional data transfers
| 
 | explicit | 
Creates an empty data endpoint
| bool addSniffer | ( | DataConsumer * | sniffer | ) | 
Adds a data consumer to the list of sniffers of the local call data
| sniffer | Pointer to the DataConsumer to add to sniffer list | 
| 
 | inline | 
Clear the owner call endpoint. Works only if the caller provides the correct owner pointer
| call | Pointer to the call endpoint that is to be cleared | 
| bool clearData | ( | DataNode * | node | ) | 
Clear a data node from any slot of this object
| node | Pointer to DataSource or DataConsumer to clear | 
| void clearSniffers | ( | ) | 
Removes all sniffers from the list and dereferences them
| 
 | static | 
Get the big mutex that serializes access to all data endpoints
| bool connect | ( | DataEndpoint * | peer | ) | 
Connect the source and consumer of the endpoint to a peer
| peer | Pointer to the peer data endpoint | 
| 
 | virtual | 
Modify data parameters
| params | The list of parameters to change | 
| bool delSniffer | ( | DataConsumer * | sniffer | ) | 
Remove a data consumer from the list of sniffers of the local call data
| sniffer | Pointer to the DataConsumer to remove from sniffer list | 
| 
 | virtual | 
Endpoint destruct notification, clears source and consumer
Reimplemented from RefObject.
| bool disconnect | ( | ) | 
Disconnect from the connected endpoint
| 
 | inline | 
Get a pointer to the owner call
| 
 | inline | 
Get the data consumer used for recording local call generated data.
| 
 | inline | 
Get the data consumer of this object
| 
 | virtual | 
Get a pointer to a derived class given that class name
| name | Name of the class we are asking for | 
Reimplemented from RefObject.
| 
 | inline | 
Get a pointer to the peer endpoint
| 
 | inline | 
Get the data consumer used for recording peer generated data.
| DataConsumer * getSniffer | ( | const String & | name, | 
| bool | ref = false ) | 
Find a sniffer by name
| name | Name of the sniffer to find | 
| ref | Increment the reference counter before returning | 
| 
 | inline | 
Get the data source of this object
| Mutex * mutex | ( | ) | const | 
Get the mutex that serializes access to this data endpoint, if any
| 
 | inline | 
Get the name set in constructor
| 
 | inlineprotectedvirtual | 
Attempt to connect the endpoint to a peer of the same type
| peer | Pointer to the endpoint data driver | 
| void setCallRecord | ( | DataConsumer * | consumer = 0 | ) | 
Set the data consumer for recording local call generated data This will be connected to the local data source.
| consumer | A pointer to the new consumer or NULL | 
| void setConsumer | ( | DataConsumer * | consumer = 0 | ) | 
Set the data consumer of this object
| consumer | A pointer to the new consumer or NULL | 
| void setPeerRecord | ( | DataConsumer * | consumer = 0 | ) | 
Set the data consumer for recording peer generated data. This will be connected to the peer data source.
| consumer | A pointer to the new consumer or NULL | 
| void setSource | ( | DataSource * | source = 0 | ) | 
Set the data source of this object
| source | A pointer to the new source or NULL | 
| 
 | virtual | 
Get a string identification of the endpoint
Reimplemented from GenObject.