nidas  v1.2-1520
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
nidas::dynld::UDPSampleOutput Class Reference

Interface of an output stream of samples. More...

#include <UDPSampleOutput.h>

Inheritance diagram for nidas::dynld::UDPSampleOutput:
Inheritance graph
[legend]

Classes

class  ConnectionMonitor
 Thread that waits for connections to die. More...
 
class  VariableListWorker
 Worker thread that is run when a connection comes in, sending XML over a socket. More...
 
class  XMLSocketListener
 Thread that waits for a connection on a tcp socket, starting a VariableListWorker on each connection. More...
 

Public Member Functions

 UDPSampleOutput ()
 
 ~UDPSampleOutput ()
 
void flush () throw ()
 Implementation of SampleClient::flush(). More...
 
void allocateBuffer (size_t len)
 
nidas::core::SampleOutputconnected (nidas::core::IOChannel *) throw ()
 Implementation of IOChannelRequester::connected(). More...
 
bool receive (const nidas::core::Sample *s) throw ()
 Method called to pass a sample to this client. More...
 
size_t write (const struct iovec *iov, int iovcnt) throw (nidas::util::IOException)
 
void close () throw (nidas::util::IOException)
 
long long getNumOutputBytes () const
 Total number of bytes written with this IOStream. More...
 
void addNumOutputBytes (int val)
 
void fromDOMElement (const xercesc::DOMElement *node) throw (nidas::util::InvalidParameterException)
 Initialize myself from a xercesc::DOMElement. More...
 
virtual void setIOChannel (IOChannel *val)
 Set the IOChannel for this SampleOutput. More...
 
SampleOutputgetOriginal () const
 Get pointer to SampleOutput that was cloned. More...
 
void setName (const std::string &val)
 
const std::string & getName () const
 
bool isRaw () const
 
void addRequestedSampleTag (SampleTag *tag) throw (nidas::util::InvalidParameterException)
 Some SampleOutputs don't send out all the Samples that they receive. More...
 
std::list< const SampleTag * > getRequestedSampleTags () const
 
void addSourceSampleTag (const SampleTag *tag) throw (nidas::util::InvalidParameterException)
 Some SampleOutputs like to be informed of what SampleTags they will be receiving from their SampleSources before they make a connection. More...
 
void addSourceSampleTags (const std::list< const SampleTag * > &tags) throw (nidas::util::InvalidParameterException)
 
std::list< const SampleTag * > getSourceSampleTags () const
 
void requestConnection (SampleConnectionRequester *) throw (nidas::util::IOException)
 Request a connection, but don't wait for it. More...
 
int getReconnectDelaySecs () const
 Base class implementation. More...
 
void setReconnectDelaySecs (int val)
 
int getFd () const
 
dsm_time_t getNextFileTime () const
 
void createNextFile (dsm_time_t) throw (nidas::util::IOException)
 
size_t write (const void *buf, size_t len) override throw (nidas::util::IOException)
 Raw write method, typically used to write the initial header. More...
 
IOChannelgetIOChannel () const
 
void setHeaderSource (HeaderSource *val)
 
void setDSMConfig (const DSMConfig *val)
 
const DSMConfiggetDSMConfig () const
 
size_t getNumDiscardedSamples () const
 
void addParameter (Parameter *val)
 Add a parameter to this DSMSensor. More...
 
const std::list< const
Parameter * > & 
getParameters () const
 Get list of parameters. More...
 
const ParametergetParameter (const std::string &name) const
 Fetch a parameter by name. More...
 
void setLatency (float val) throw (nidas::util::InvalidParameterException)
 Set desired latency, providing some control over the response time vs buffer efficiency tradeoff. More...
 
float getLatency () const
 
virtual xercesc::DOMElement * toDOMParent (xercesc::DOMElement *parent, bool complete) const throw (xercesc::DOMException)
 Create a DOMElement and append it to the parent. More...
 
virtual xercesc::DOMElement * toDOMElement (xercesc::DOMElement *node, bool complete) const throw (xercesc::DOMException)
 Add my content into a DOMElement. More...
 

Static Public Member Functions

static const XMLCh * getNamespaceURI ()
 

Protected Member Functions

UDPSampleOutputclone (nidas::core::IOChannel *iochannel)
 This SampleOutput does not support cloning. More...
 
 UDPSampleOutput (UDPSampleOutput &, nidas::core::IOChannel *)
 This SampleOutput does not support a copy constructor with a new IOChannel. More...
 
size_t incrementDiscardedSamples ()
 
SampleConnectionRequestergetSampleConnectionRequester ()
 
void disconnect () throw (nidas::util::IOException)
 Close the IOChannel and notify whoever did the requestConnection that it is time to disconnect, perhaps because of an IOException. More...
 

Protected Attributes

std::string _name
 

Private Member Functions

xercesc::DOMDocument * getProjectDOM () throw (xercesc::DOMException)
 Get a pointer to the current project DOM. More...
 
void releaseProjectDOM ()
 
 UDPSampleOutput (const UDPSampleOutput &)
 No copying. More...
 
UDPSampleOutputoperator= (const UDPSampleOutput &)
 No assignment. More...
 

Private Attributes

nidas::core::MultipleUDPSockets_mochan
 
xercesc::DOMDocument * _doc
 
bool _projectChanged
 
nidas::util::Mutex _docLock
 
nidas::util::RWLock _docRWLock
 
nidas::util::Mutex _listenerLock
 
unsigned short _xmlPortNumber
 
unsigned short _multicastOutPort
 
XMLSocketListener_listener
 
ConnectionMonitor_monitor
 
long long _nbytesOut
 
char * _buffer
 data buffer More...
 
char * _head
 where we insert bytes into the buffer More...
 
char * _tail
 where we remove bytes from the buffer More...
 
size_t _buflen
 The actual buffer size. More...
 
char * _eob
 One past end of buffer. More...
 
nidas::core::dsm_time_t _lastWrite
 Time of last physical write. More...
 
int _maxUsecs
 Maximum number of microseconds between physical writes. More...
 

Detailed Description

Interface of an output stream of samples.

Constructor & Destructor Documentation

UDPSampleOutput::UDPSampleOutput ( )
UDPSampleOutput::~UDPSampleOutput ( )
UDPSampleOutput::UDPSampleOutput ( UDPSampleOutput ,
nidas::core::IOChannel  
)
protected

This SampleOutput does not support a copy constructor with a new IOChannel.

It will die with an assert.

References nidas::util::Logger::getInstance(), nidas::util::Logger::log(), and LOG_ERR.

nidas::dynld::UDPSampleOutput::UDPSampleOutput ( const UDPSampleOutput )
private

No copying.

Member Function Documentation

void nidas::dynld::UDPSampleOutput::addNumOutputBytes ( int  val)
inline

References _nbytesOut.

void SampleOutputBase::addParameter ( Parameter val)
inherited

Add a parameter to this DSMSensor.

DSMSensor will then own the pointer and will delete it in its destructor. If a Parameter exists with the same name, it will be replaced with the new Parameter.

References nidas::core::SampleOutputBase::_constParameters, nidas::core::SampleOutputBase::_parameters, and nidas::core::Parameter::getName().

void SampleOutputBase::addRequestedSampleTag ( SampleTag tag)
throw (nidas::util::InvalidParameterException
)
virtualinherited

Some SampleOutputs don't send out all the Samples that they receive.

At configuration time, one can use this method to request the SampleTags that should be output from a SampleOutput. SampleOutput will own the pointer.

Implements nidas::core::SampleOutput.

Reimplemented in nidas::dynld::isff::GOESOutput, and nidas::dynld::raf::CVIOutput.

Referenced by nidas::dynld::raf::CVIOutput::addRequestedSampleTag(), nidas::dynld::isff::GOESOutput::addRequestedSampleTag(), and nidas::core::SampleOutputBase::SampleOutputBase().

void SampleOutputBase::addSourceSampleTag ( const SampleTag tag)
throw (nidas::util::InvalidParameterException
)
virtualinherited

Some SampleOutputs like to be informed of what SampleTags they will be receiving from their SampleSources before they make a connection.

Users of SampleOutputs should call this method before calling requestConnection().

Implements nidas::core::SampleOutput.

Reimplemented in nidas::dynld::isff::GOESOutput.

Referenced by nidas::dynld::isff::GOESOutput::addSourceSampleTag(), and nidas::core::SampleOutputBase::SampleOutputBase().

void SampleOutputBase::addSourceSampleTags ( const std::list< const SampleTag * > &  tags)
throw (nidas::util::InvalidParameterException
)
virtualinherited
void UDPSampleOutput::allocateBuffer ( size_t  len)

References _buffer, _buflen, _eob, _head, _tail, and len.

UDPSampleOutput * UDPSampleOutput::clone ( nidas::core::IOChannel iochannel)
protectedvirtual

This SampleOutput does not support cloning.

It will die with an assert.

Implements nidas::core::SampleOutput.

References nidas::util::Logger::getInstance(), nidas::util::Logger::log(), and LOG_ERR.

void UDPSampleOutput::close ( )
throw (nidas::util::IOException
)
virtual
SampleOutput * UDPSampleOutput::connected ( nidas::core::IOChannel ochan)
throw (
)
virtual
void SampleOutputBase::createNextFile ( dsm_time_t  tt)
throw (nidas::util::IOException
)
inherited
void SampleOutputBase::disconnect ( )
throw (nidas::util::IOException
)
protectedinherited

Close the IOChannel and notify whoever did the requestConnection that it is time to disconnect, perhaps because of an IOException.

This is typically called in the receive() method of a SampleOutput if it gets an IOException when writing data. A common implementation of a connection requester is to delete this SampleOutput after the removing it from the sample stream. So the caller method should immediately return after calling disconnect().

References nidas::core::SampleOutputBase::_connectionRequester, nidas::core::SampleOutputBase::close(), nidas::core::SampleConnectionRequester::disconnect(), nidas::core::SampleOutputBase::getName(), and ILOG.

void nidas::dynld::UDPSampleOutput::flush ( )
throw (
)
inlinevirtual

Implementation of SampleClient::flush().

Implements nidas::core::SampleClient.

void UDPSampleOutput::fromDOMElement ( const xercesc::DOMElement *  )
throw (nidas::util::InvalidParameterException
)
virtual
const DSMConfig* nidas::core::SampleOutputBase::getDSMConfig ( ) const
inlinevirtualinherited
int SampleOutputBase::getFd ( ) const
virtualinherited
IOChannel* nidas::core::SampleOutputBase::getIOChannel ( ) const
inlinevirtualinherited
float nidas::core::SampleOutputBase::getLatency ( ) const
inlinevirtualinherited
const std::string& nidas::core::SampleOutputBase::getName ( ) const
inlinevirtualinherited
static const XMLCh* nidas::core::DOMable::getNamespaceURI ( )
inlinestaticinherited
dsm_time_t nidas::core::SampleOutputBase::getNextFileTime ( ) const
inlineinherited
size_t nidas::core::SampleOutputBase::getNumDiscardedSamples ( ) const
inlineinherited
long long nidas::dynld::UDPSampleOutput::getNumOutputBytes ( ) const
inline

Total number of bytes written with this IOStream.

References _nbytesOut.

SampleOutput* nidas::core::SampleOutputBase::getOriginal ( ) const
inlinevirtualinherited

Get pointer to SampleOutput that was cloned.

Will be NULL if this SampleOutput is an un-cloned original.

Implements nidas::core::SampleOutput.

const Parameter * SampleOutputBase::getParameter ( const std::string &  name) const
inherited

Fetch a parameter by name.

Returns a NULL pointer if no such parameter exists.

References nidas::core::SampleOutputBase::_parameters.

const std::list<const Parameter*>& nidas::core::SampleOutputBase::getParameters ( ) const
inlineinherited

Get list of parameters.

xercesc::DOMDocument * UDPSampleOutput::getProjectDOM ( )
throw (xercesc::DOMException
)
private
int SampleOutputBase::getReconnectDelaySecs ( ) const
virtualinherited

Base class implementation.

If setReconnectDelaySecs() has been called on this SampleOutput, then that value will be returned. Otherwise this will return the value of the IOChannel.

Implements nidas::core::SampleOutput.

References nidas::core::SampleOutputBase::_iochan, nidas::core::SampleOutputBase::_reconnectDelaySecs, and nidas::core::IOChannel::getReconnectDelaySecs().

std::list< const SampleTag * > SampleOutputBase::getRequestedSampleTags ( ) const
virtualinherited
SampleConnectionRequester* nidas::core::SampleOutputBase::getSampleConnectionRequester ( )
inlineprotectedinherited
list< const SampleTag * > SampleOutputBase::getSourceSampleTags ( ) const
virtualinherited
size_t nidas::core::SampleOutputBase::incrementDiscardedSamples ( )
inlineprotectedinherited
bool nidas::core::SampleOutputBase::isRaw ( ) const
inlinevirtualinherited
UDPSampleOutput& nidas::dynld::UDPSampleOutput::operator= ( const UDPSampleOutput )
private

No assignment.

bool UDPSampleOutput::receive ( const nidas::core::Sample s)
throw (
)
virtual

Method called to pass a sample to this client.

This method is typically called by a SampleSource for each of its SampleClients when it has a sample ready. Returns true: success false: sample rejected. This is meant to signal a warning-type situation - like a socket not being available temporarily. True errors will be thrown as an IOException.

Implements nidas::core::SampleClient.

References nidas::util::Logger::getInstance(), nidas::core::SampleHeader::getSizeOf(), nidas::util::Logger::log(), LOG_ERR, LOG_WARNING, nidas::core::SampleHeader::setDataByteLength(), nidas::core::SampleHeader::setRawId(), nidas::core::SampleHeader::setTimeTag(), and nidas::util::Exception::what().

void UDPSampleOutput::releaseProjectDOM ( )
private
void SampleOutputBase::requestConnection ( SampleConnectionRequester requester)
throw (nidas::util::IOException
)
virtualinherited

Request a connection, but don't wait for it.

Requester will be notified via SampleConnectionRequester interface when the connection has been made. It is not necessary to call this method if a SampleOutput is constructed with a connected IOChannel.

Implements nidas::core::SampleOutput.

Reimplemented in nidas::dynld::psql::PSQLSampleOutput, nidas::dynld::raf::CVIOutput, and nidas::dynld::AsciiOutput.

Referenced by nidas::dynld::AsciiOutput::requestConnection(), and nidas::dynld::raf::CVIOutput::requestConnection().

void nidas::core::SampleOutputBase::setDSMConfig ( const DSMConfig val)
inlinevirtualinherited
void nidas::core::SampleOutputBase::setHeaderSource ( HeaderSource val)
inlinevirtualinherited
void SampleOutputBase::setIOChannel ( IOChannel val)
virtualinherited
void nidas::core::SampleOutputBase::setLatency ( float  val)
throw (nidas::util::InvalidParameterException
)
inlinevirtualinherited

Set desired latency, providing some control over the response time vs buffer efficiency tradeoff.

Setting a latency of 1/10 sec means buffer data in the IOStream for a 1/10 sec, then send the data to the physical device.

Parameters
valLatency, in seconds.

Implements nidas::core::SampleOutput.

Reimplemented in nidas::dynld::SampleOutputStream.

Referenced by nidas::dynld::SampleOutputStream::setLatency().

void nidas::core::SampleOutputBase::setName ( const std::string &  val)
inlinevirtualinherited
void SampleOutputBase::setReconnectDelaySecs ( int  val)
virtualinherited
xercesc::DOMElement * DOMable::toDOMElement ( xercesc::DOMElement *  node,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited
xercesc::DOMElement * DOMable::toDOMParent ( xercesc::DOMElement *  parent,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited
size_t UDPSampleOutput::write ( const struct iovec *  iov,
int  iovcnt 
)
throw (nidas::util::IOException
)
size_t SampleOutputBase::write ( const void *  buf,
size_t  len 
)
throw (nidas::util::IOException
)
overridevirtualinherited

Raw write method, typically used to write the initial header.

Implements nidas::core::SampleOutput.

Reimplemented in nidas::dynld::isff::GOESOutput.

References len.

Member Data Documentation

char* nidas::dynld::UDPSampleOutput::_buffer
private

data buffer

Referenced by allocateBuffer().

size_t nidas::dynld::UDPSampleOutput::_buflen
private

The actual buffer size.

Referenced by allocateBuffer().

xercesc::DOMDocument* nidas::dynld::UDPSampleOutput::_doc
private

Referenced by getProjectDOM().

nidas::util::Mutex nidas::dynld::UDPSampleOutput::_docLock
private

Referenced by getProjectDOM().

nidas::util::RWLock nidas::dynld::UDPSampleOutput::_docRWLock
private

Referenced by getProjectDOM(), and releaseProjectDOM().

char* nidas::dynld::UDPSampleOutput::_eob
private

One past end of buffer.

Referenced by allocateBuffer().

char* nidas::dynld::UDPSampleOutput::_head
private

where we insert bytes into the buffer

Referenced by allocateBuffer().

nidas::core::dsm_time_t nidas::dynld::UDPSampleOutput::_lastWrite
private

Time of last physical write.

XMLSocketListener* nidas::dynld::UDPSampleOutput::_listener
private

Referenced by close(), and ~UDPSampleOutput().

nidas::util::Mutex nidas::dynld::UDPSampleOutput::_listenerLock
private
int nidas::dynld::UDPSampleOutput::_maxUsecs
private

Maximum number of microseconds between physical writes.

nidas::core::MultipleUDPSockets* nidas::dynld::UDPSampleOutput::_mochan
private
ConnectionMonitor* nidas::dynld::UDPSampleOutput::_monitor
private
unsigned short nidas::dynld::UDPSampleOutput::_multicastOutPort
private
std::string nidas::core::SampleOutputBase::_name
protectedinherited
long long nidas::dynld::UDPSampleOutput::_nbytesOut
private
bool nidas::dynld::UDPSampleOutput::_projectChanged
private

Referenced by getProjectDOM().

char* nidas::dynld::UDPSampleOutput::_tail
private

where we remove bytes from the buffer

Referenced by allocateBuffer().

unsigned short nidas::dynld::UDPSampleOutput::_xmlPortNumber
private

The documentation for this class was generated from the following files: