class DataEndpoint

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

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

Public Methods

Protected Methods


Detailed Description

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

inline  DataEndpoint (const char *name = 0)

DataEndpoint

Creates am empty data ednpoint

 ~DataEndpoint ()

~DataEndpoint

Destroys the endpoint, source and consumer

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

inline void  disconnect (const char *reason = 0)

disconnect

Disconnect from the connected endpoint

Parameters:
reasonText that describes disconnect reason

void  setSource (DataSource *source = 0)

setSource

Set the data source of this object

Parameters:
sourceA pointer to the new source or NULL

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

DataConsumer * getConsumer ()

getConsumer

[const]

Get the data consumer of this object

Returns: A pointer to the DataConsumer object or NULL

inline DataEndpoint * getPeer ()

getPeer

[const]

inline const String & name ()

name

[const]

Get the name set in constructor

Returns: A reference to the name as hashed string

void  connected ()

connected

[protected virtual]

Connect notification method

void  disconnected (bool final, const char *reason)

disconnected

[protected virtual]

Disconnect notification method

Parameters:
finalTrue if this disconnect was called from the destructor
reasonText that describes disconnect reason

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

void  setPeer (DataEndpoint *peer, const char *reason = 0)

setPeer

[protected]


Generated by: kk on nyx on Sat Jun 4 19:29:41 2005, using kdoc 2.0a54.