DataEndpoint Class Reference
A data transfer endpoint capable of sending and/or receiving data.
More...
#include <yatephone.h>
List of all members.
Detailed Description
A data transfer endpoint capable of sending and/or receiving data.
The DataEndpoint holds an endpoint capable of performing unidirectional or bidirectional data transfers
Constructor & Destructor Documentation
Creates an empty data endpoint
Member Function Documentation
virtual void destroyed |
( |
|
) |
[virtual] |
Endpoint destruct notification, clears source and consumer
Reimplemented from RefObject.
virtual void* getObject |
( |
const String & |
name |
) |
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.
virtual const String& toString |
( |
|
) |
const [virtual] |
Get a string identification of the endpoint
- Returns:
- A reference to this endpoint's name
Reimplemented from GenObject.
Get the mutex that serializes access to this data endpoint, if any
- Returns:
- Pointer to the call's mutex object or NULL
static Mutex& commonMutex |
( |
|
) |
[static] |
Get the big mutex that serializes access to all data endpoints
- Returns:
- A reference to the mutex
Connect the source and consumer of the endpoint to a peer
- Parameters:
-
| peer | Pointer to the peer data endpoint |
- Returns:
- True if connected, false if incompatible source/consumer
Disconnect from the connected endpoint
- Returns:
- True if the object was deleted, false if it still exists
Set the data source of this object
- Parameters:
-
| source | A pointer to the new source or NULL |
Get the data source of this object
- Returns:
- A pointer to the DataSource object or NULL
Set the data consumer of this object
- Parameters:
-
| consumer | A pointer to the new consumer or NULL |
Get the data consumer of this object
- Returns:
- A pointer to the DataConsumer object or NULL
Set the data consumer for recording peer generated data. This will be connected to the peer data source.
- Parameters:
-
| consumer | A pointer to the new consumer or NULL |
Get the data consumer used for recording peer generated data.
- Returns:
- A pointer to the DataConsumer object or NULL
Set the data consumer for recording local call generated data This will be connected to the local data source.
- Parameters:
-
| consumer | A pointer to the new consumer or NULL |
Get the data consumer used for recording local call generated data.
- Returns:
- A pointer to the DataConsumer object or NULL
Clear a data node from any slot of this object
- Parameters:
-
- Returns:
- True if the node was removed from at least one slot
Adds a data consumer to the list of sniffers of the local call data
- Parameters:
-
- Returns:
- True if the sniffer was added to list, false if NULL or already added
Remove a data consumer from the list of sniffers of the local call data
- Parameters:
-
| sniffer | Pointer to the DataConsumer to remove from sniffer list |
- Returns:
- True if the sniffer was removed from list
Find a sniffer by name
- Parameters:
-
| name | Name of the sniffer to find |
- Returns:
- Pointer to DataConsumer or NULL if not found
Removes all sniffers from the list and dereferences them
Get a pointer to the peer endpoint
- Returns:
- A pointer to the peer endpoint or NULL
Get a pointer to the owner call
- Returns:
- A pointer to the owner call or NULL
const String& name |
( |
|
) |
const [inline] |
Get the name set in constructor
- Returns:
- A reference to the name as hashed string
Clear the owner call endpoint. Works only if the caller provides the correct owner pointer
- Parameters:
-
| call | Pointer to the call endpoint that is to be cleared |
virtual bool control |
( |
NamedList & |
params |
) |
[virtual] |
Modify data parameters
- Parameters:
-
| params | The list of parameters to change |
- Returns:
- True if processed
virtual bool nativeConnect |
( |
DataEndpoint * |
peer |
) |
[inline, protected, virtual] |
Attempt to connect the endpoint to a peer of the same type
- Parameters:
-
| peer | Pointer to the endpoint data driver |
- Returns:
- True if connected, false if failed native connection
The documentation for this class was generated from the following file: