class DataEndpoint

A data transfer endpoint capable of sending and/or receiving data. More...

Full nameTelEngine::DataEndpoint
Definition#include <yatephone.h>
InheritsTelEngine::RefObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Methods


Detailed Description

The DataEndpoint holds an endpoint capable of performing unidirectional or bidirectional data transfers

 DataEndpoint (CallEndpoint* call = 0, const char* name = "audio")

DataEndpoint

Creates an empty data endpoint

 ~DataEndpoint ()

~DataEndpoint

Destroys the endpoint, source and consumer

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName 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 identification of the endpoint

Returns: A reference to this endpoint's name

Reimplemented from GenObject.

Mutex*  mutex ()

mutex

[const]

Get the mutex that serializes access to this data 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 data endpoints

Returns: A reference to the mutex

bool  connect (DataEndpoint* peer)

connect

Connect the source and consumer of the endpoint to a peer

Parameters:
peerPointer to the peer data endpoint

Returns: True if connected, false if incompatible source/consumer

bool  disconnect ()

disconnect

Disconnect from the connected endpoint

Returns: True if the object was deleted, false if it still exists

void  setSource (DataSource* source = 0)

setSource

Set the data source of this object

Parameters:
sourceA pointer to the new source or NULL

inline DataSource*  getSource ()

getSource

[const]

Get the data source of this object

Returns: A pointer to the DataSource object or NULL

void  setConsumer (DataConsumer* consumer = 0)

setConsumer

Set the data consumer of this object

Parameters:
consumerA pointer to the new consumer or NULL

inline DataConsumer*  getConsumer ()

getConsumer

[const]

Get the data consumer of this object

Returns: A pointer to the DataConsumer object or NULL

void  setPeerRecord (DataConsumer* consumer = 0)

setPeerRecord

Set the data consumer for recording peer generated data. This will be connected to the peer data source.

Parameters:
consumerA pointer to the new consumer or NULL

inline DataConsumer*  getPeerRecord ()

getPeerRecord

[const]

Get the data consumer used for recording peer generated data.

Returns: A pointer to the DataConsumer object or NULL

void  setCallRecord (DataConsumer* consumer = 0)

setCallRecord

Set the data consumer for recording local call generated data This will be connected to the local data source.

Parameters:
consumerA pointer to the new consumer or NULL

inline DataConsumer*  getCallRecord ()

getCallRecord

[const]

Get the data consumer used for recording local call generated data.

Returns: A pointer to the DataConsumer object or NULL

bool  addSniffer (DataConsumer* sniffer)

addSniffer

Adds a data consumer to the list of sniffers of the local call data

Parameters:
snifferPointer to the DataConsumer to add to sniffer list

Returns: True if the sniffer was added to list, false if NULL or already added

bool  delSniffer (DataConsumer* sniffer)

delSniffer

Remove a data consumer from the list of sniffers of the local call data

Parameters:
snifferPointer to the DataConsumer to remove from sniffer list

Returns: True if the sniffer was removed from list

inline DataConsumer*  getSniffer (const String& name)

getSniffer

Find a sniffer by name

Parameters:
nameName of the sniffer to find

Returns: Pointer to DataConsumer or NULL if not found

void  clearSniffers ()

clearSniffers

Removes all sniffers from the list and dereferences them

inline DataEndpoint*  getPeer ()

getPeer

[const]

Get a pointer to the peer endpoint

Returns: A pointer to the peer endpoint or NULL

inline CallEndpoint*  getCall ()

getCall

[const]

Get a pointer to the owner call

Returns: A pointer to the owner call or NULL

inline const String&  name ()

name

[const]

Get the name set in constructor

Returns: A reference to the name as hashed string

bool  nativeConnect (DataEndpoint* peer)

nativeConnect

[protected virtual]

Attempt to connect the endpoint to a peer of the same type

Parameters:
peerPointer to the endpoint data driver

Returns: True if connected, false if failed native connection


Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54.