Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

SH::FileSinkSH Class Reference
[StreamHandlers]

#include <MNFileSinkSH.h>

Inheritance diagram for SH::FileSinkSH:

Inheritance graph
[legend]
Collaboration diagram for SH::FileSinkSH:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FileSinkSH (SHGraphManager *mgr, u_int32_t runtimeId, MNSelector &sel)
virtual ~FileSinkSH ()
virtual SH_RC initSH ()
virtual SH_RC uninitSH ()
SH_RC push_to_file (DataPtr item)
virtual SinkEndpoint ** getSinkSpecs ()
virtual SourceEndpoint ** getSourceSpecs ()
virtual bool isConnected () const

Public Attributes

SA_FILE_NAME _filename
SA_FILESNK_CREAT _creat
SA_FILESNK_APPEND _append
SA_HAS_ORDERED_DATA _hasOrderedData
int _file_handle
long _call_count
long _bytes_written
long _file_offset

Protected Attributes

SinkEndpoint_in_ep_a [1]
FileSinkEndpoint _inEP

Constructor & Destructor Documentation

SH::FileSinkSH::FileSinkSH SHGraphManager mgr,
u_int32_t  runtimeId,
MNSelector sel
 

virtual SH::FileSinkSH::~FileSinkSH  )  [virtual]
 


Member Function Documentation

virtual SinkEndpoint** SH::FileSinkSH::getSinkSpecs  )  [virtual]
 

Provide a list of valid sink endpoint specifications to the graph manager.
getSinkPorts() is called by the graph manager and returns an array of pointers to EndpointSpec structures, or NULL if no endpoints in this direction are supported. It is typical that the length of such an array is 1, because several alternatives are specified by one EndpointSpec object, and the maximum number of identical Endpoints is a parameter of the EndpointSpec as well. The maximum number of endpoints may be dynamic, e.g. in an RTP source SH, new SSRCs or PTs will result in the provision of a new Endpoint. The array of endpoint specs is not NULL terminated, it is expected that the application knows the number of endpoints from numSinkSpecs().

Returns:
An array of endpoint specification.

Implements SH::Status.

virtual SourceEndpoint** SH::FileSinkSH::getSourceSpecs  )  [virtual]
 

Provide a list of valid source endpoint specifications to the graph manager.
getSourceSpecs() works like getSinkSpecs() but on the source endpoint specifications.

Returns:
An array of endpoint specification.

Implements SH::Status.

virtual SH_RC SH::FileSinkSH::initSH  )  [virtual]
 

See also:
Base

Reimplemented from SH::Base.

virtual bool SH::FileSinkSH::isConnected  )  const [virtual]
 

Indicate whether a sufficient number of endpoints are connected for the stream handler to be active.
True if a sufficient number of endpoints is connected for the stream handler to operate in a graph. This should always be true when the stream handler is part of an active graph. This can be called on all stream handlers of a graph to determine whether it will activate successfully.

Implements SH::Status.

SH_RC SH::FileSinkSH::push_to_file DataPtr  item  ) 
 

virtual SH_RC SH::FileSinkSH::uninitSH  )  [virtual]
 

See also:
Base

Reimplemented from SH::Base.


Member Data Documentation

SA_FILESNK_APPEND SH::FileSinkSH::_append
 

long SH::FileSinkSH::_bytes_written
 

long SH::FileSinkSH::_call_count
 

SA_FILESNK_CREAT SH::FileSinkSH::_creat
 

int SH::FileSinkSH::_file_handle
 

long SH::FileSinkSH::_file_offset
 

SA_FILE_NAME SH::FileSinkSH::_filename
 

The name of the file that we write to. The string that is passed as a parameter must be a copy that the SH can keep. The SH will release the string using free().

SA_HAS_ORDERED_DATA SH::FileSinkSH::_hasOrderedData
 

SinkEndpoint* SH::FileSinkSH::_in_ep_a[1] [protected]
 

FileSinkEndpoint SH::FileSinkSH::_inEP [protected]
 


The documentation for this class was generated from the following file:
Generated on Sun Mar 6 13:36:28 2005 for Komssys by doxygen 1.3.8