nidas
v1.2-1520
|
Implementation of an IOChannel, using nidas::util::McSocket<nidas::util::Socket> to establish a TCP connection. More...
#include <McSocket.h>
Classes | |
class | MyMcSocket |
Public Member Functions | |
McSocket () | |
Constructor. More... | |
~McSocket () | |
McSocket * | clone () const |
Derived classes must provide clone. More... | |
void | setRequestType (enum McSocketRequest val) |
enum McSocketRequest | getRequestType () const |
bool | isRequester () const |
Does this McSocket request connections, or does it listen for incoming connections. More... | |
void | setRequester (bool val) |
void | setName (const std::string &val) |
const std::string & | getName () const |
void | requestConnection (IOChannelRequester *service) throw (nidas::util::IOException) |
After the IOChannel is configured, a user of IOChannel calls requestConnection to get things started. More... | |
IOChannel * | connect () throw (nidas::util::IOException) |
Establish a connection. More... | |
virtual void | connected (nidas::util::Socket *sock, const nidas::util::Inet4PacketInfoX &pktinfo) |
virtual bool | isNewInput () const |
Some IOChannels, namely FileSet, which opens successive files, need to indicate when a read is from the start of a new file. More... | |
void | setKeepAliveIdleSecs (int val) throw (nidas::util::IOException) |
int | getKeepAliveIdleSecs () const throw (nidas::util::IOException) |
void | setNonBlocking (bool val) throw (nidas::util::IOException) |
Do setNonBlocking(val) on underlying socket. More... | |
bool | isNonBlocking () const throw (nidas::util::IOException) |
Return isNonBlocking() of underlying socket. More... | |
size_t | read (void *, size_t) throw (nidas::util::IOException) |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection. More... | |
size_t | write (const void *, size_t) throw (nidas::util::IOException) |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection. More... | |
size_t | write (const struct iovec *, int) throw (nidas::util::IOException) |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection. More... | |
void | close () throw (nidas::util::IOException) |
int | getFd () const |
void | fromDOMElement (const xercesc::DOMElement *) throw (nidas::util::InvalidParameterException) |
Initialize myself from a xercesc::DOMElement. More... | |
void | setInet4McastSocketAddress (const nidas::util::Inet4SocketAddress &val) |
const nidas::util::Inet4SocketAddress & | getInet4McastSocketAddress () const |
virtual int | getReconnectDelaySecs () const |
virtual const ConnectionInfo & | getConnectionInfo () const |
What is the IP address of the host at the other end of the connection. More... | |
virtual void | setConnectionInfo (const ConnectionInfo &val) |
virtual size_t | getBufferSize () const throw () |
Return suggested buffer length. More... | |
virtual void | flush () throw (nidas::util::IOException) |
Default flush implementation does nothing. More... | |
virtual dsm_time_t | createFile (dsm_time_t t, bool exact) |
Request that an IOChannel open a new file, with a name based on a time. More... | |
virtual bool | writeNidasHeader () const |
Should the NIDAS header be written to this IOChannel? NIDAS headers are not written to DatagramSockets, because there is no guarantee they will get there. More... | |
virtual void | setDSMConfig (const DSMConfig *val) |
What DSM is this IOChannel connected to? More... | |
virtual const DSMConfig * | getDSMConfig () const |
What DSM is this IOChannel connected to? May be NULL. More... | |
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 IOChannel * | createIOChannel (const xercesc::DOMElement *node) throw (nidas::util::InvalidParameterException) |
static const XMLCh * | getNamespaceURI () |
Protected Member Functions | |
McSocket (const McSocket &) | |
Copy constructor. More... | |
Protected Attributes | |
IOChannelRequester * | _iochanRequester |
MyMcSocket | _mcsocket |
Private Member Functions | |
McSocket & | operator= (const McSocket &) |
No assignment. More... | |
Private Attributes | |
std::string | _name |
bool | _amRequester |
bool | _firstRead |
bool | _newInput |
int | _keepAliveIdleSecs |
bool | _nonBlocking |
Implementation of an IOChannel, using nidas::util::McSocket<nidas::util::Socket> to establish a TCP connection.
|
inline |
|
protected |
Copy constructor.
Should only be called before nidas::util::Socket is connected.
|
virtual |
|
virtual |
Implements nidas::core::IOChannel.
References _mcsocket, and nidas::util::McSocket< SocketT >::close().
|
virtual |
Establish a connection.
On return, the connection has been established. It may return a new instance of an IOChannel.
Implements nidas::core::IOChannel.
References _keepAliveIdleSecs, _mcsocket, nidas::util::McSocket< SocketT >::accept(), nidas::util::McSocket< SocketT >::connect(), nidas::util::Inet4PacketInfo::getDestinationAddress(), nidas::util::Inet4PacketInfo::getInterface(), nidas::util::Inet4PacketInfoX::getRemoteSocketAddress(), getRequestType(), isNonBlocking(), isRequester(), nidas::core::IOChannel::setConnectionInfo(), nidas::util::Socket::setKeepAliveIdleSecs(), nidas::util::Socket::setNonBlocking(), and nidas::core::Socket::setRequestType().
|
virtual |
References _iochanRequester, _keepAliveIdleSecs, nidas::core::IOChannelRequester::connected(), nidas::util::Inet4PacketInfo::getDestinationAddress(), nidas::util::Inet4PacketInfo::getInterface(), nidas::util::Inet4PacketInfoX::getRemoteSocketAddress(), getRequestType(), isNonBlocking(), nidas::core::IOChannel::setConnectionInfo(), nidas::util::Socket::setKeepAliveIdleSecs(), nidas::util::Socket::setNonBlocking(), and nidas::core::Socket::setRequestType().
|
inlinevirtualinherited |
Request that an IOChannel open a new file, with a name based on a time.
This should be implemented by derived classes which write to disk files. Other derived classes (e.g. sockets) can just use this default implementation - basically ignoring the request.
t | Time to use when creating file name. |
exact | Use exact time when creating file name, else the time is adjusted to an even time interval. |
Reimplemented in nidas::core::FileSet.
Referenced by nidas::core::IOStream::createFile().
|
staticinherited |
References nidas::core::DOMObjectFactory::createObject(), nidas::core::Socket::createSocket(), nidas::util::Process::expandEnvVars(), nidas::core::XDOMElement::getAttributeValue(), and nidas::core::XDOMElement::getNodeName().
Referenced by nidas::dynld::psql::PSQLSampleOutput::fromDOMElement(), nidas::core::DSMService::fromDOMElement(), nidas::dynld::isff::GOESOutput::fromDOMElement(), nidas::core::SampleOutputBase::fromDOMElement(), and nidas::dynld::SampleInputStream::fromDOMElement().
|
inlinevirtualinherited |
Default flush implementation does nothing.
Reimplemented in nidas::dynld::isff::GOESXmtr, nidas::dynld::isff::SE_GOESXmtr, and nidas::dynld::psql::PSQLChannel.
Referenced by nidas::core::SampleArchiver::disconnect(), and nidas::core::IOStream::flush().
|
virtual |
Initialize myself from a xercesc::DOMElement.
Implements nidas::core::DOMable.
References nidas::util::Process::expandEnvVars(), nidas::util::Inet4Address::getByName(), nidas::util::Logger::getInstance(), nidas::core::XDOMAttr::getName(), nidas::util::Logger::log(), LOG_WARNING, NIDAS_MULTICAST_ADDR, NIDAS_SVC_REQUEST_PORT_UDP, and port.
|
inlinevirtualinherited |
Return suggested buffer length.
Reimplemented in nidas::core::Socket, nidas::core::DatagramSocket, and nidas::core::MultipleUDPSockets.
Referenced by nidas::dynld::isff::PacketInputStream::init(), nidas::dynld::isff::PacketInputStream::PacketInputStream(), and nidas::dynld::SampleInputStream::SampleInputStream().
|
inlinevirtualinherited |
What is the IP address of the host at the other end of the connection.
If this IOChannel is not a socket then return INADDR_ANY, using the default constructor of an Inet4Address. Socket subclasses should override this.
Referenced by nidas::dynld::SampleInputStream::setIOChannel().
|
inlinevirtualinherited |
What DSM is this IOChannel connected to? May be NULL.
Referenced by nidas::core::FileSet::setDir(), and nidas::core::FileSet::setFileName().
|
virtual |
Implements nidas::core::IOChannel.
|
inline |
References _mcsocket, and nidas::util::McSocket< SocketT >::getInet4McastSocketAddress().
|
inline |
References _keepAliveIdleSecs.
|
inlinevirtual |
Implements nidas::core::IOChannel.
References _name.
|
inlinestaticinherited |
References nidas::core::DOMable::namespaceURI.
Referenced by nidas::dynld::UDPSampleOutput::getProjectDOM(), nidas::core::Dataset::toDOMElement(), nidas::core::ProjectConfig::toDOMElement(), nidas::core::Dataset::toDOMParent(), nidas::core::ProjectConfig::toDOMParent(), nidas::core::Datasets::toDOMParent(), nidas::core::ProjectConfigs::toDOMParent(), nidas::core::DSMConfig::toDOMParent(), nidas::core::Project::toDOMParent(), nidas::core::Site::toDOMParent(), nidas::core::SampleTag::toDOMParent(), nidas::core::ServerSocket::toDOMParent(), nidas::core::Variable::toDOMParent(), nidas::core::DSMSensor::toDOMParent(), nidas::core::Datasets::writeXML(), and nidas::core::ProjectConfigs::writeXML().
|
inlinevirtualinherited |
Reimplemented in nidas::core::FileSet.
Referenced by nidas::core::SampleOutputBase::getReconnectDelaySecs().
|
inlinevirtual |
Reimplemented from nidas::core::IOChannel.
References _mcsocket, and nidas::util::McSocket< SocketT >::getRequestType().
Referenced by connect(), and connected().
|
inlinevirtual |
Some IOChannels, namely FileSet, which opens successive files, need to indicate when a read is from the start of a new file.
This method is used by code which may need to do special things at the beginning of a file, like read a SampleInputHeader.
Reimplemented from nidas::core::IOChannel.
References _newInput.
|
inlinevirtual |
Return isNonBlocking() of underlying socket.
Implements nidas::core::IOChannel.
References _nonBlocking.
Referenced by connect(), and connected().
|
inline |
Does this McSocket request connections, or does it listen for incoming connections.
References _amRequester.
Referenced by connect().
|
inlinevirtual |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection.
The returned IOChannel should be used to read/write. Calling this method will fail with an assert.
Implements nidas::core::IOChannel.
|
virtual |
After the IOChannel is configured, a user of IOChannel calls requestConnection to get things started.
It is like opening a device, but in the case of server sockets, it just starts a thread to wait on connections. Only when the IOChannelRequester::connected() method is called back is the channel actually open and ready for IO. The IOChannel* returned by IOChannelRequester::connected may be another instance of an IOChannel.
Implements nidas::core::IOChannel.
|
inlinevirtualinherited |
|
inlinevirtualinherited |
What DSM is this IOChannel connected to?
Referenced by nidas::core::SampleOutputBase::fromDOMElement(), nidas::core::SampleOutputBase::SampleOutputBase(), and nidas::core::SampleOutputBase::setIOChannel().
|
inline |
References _mcsocket, and nidas::util::McSocket< SocketT >::setInet4McastSocketAddress().
|
inline |
References _keepAliveIdleSecs.
|
inlinevirtual |
|
inlinevirtual |
Do setNonBlocking(val) on underlying socket.
Implements nidas::core::IOChannel.
References _nonBlocking.
|
inline |
References _amRequester.
|
inlinevirtual |
Reimplemented from nidas::core::IOChannel.
References _mcsocket, and nidas::util::McSocket< SocketT >::setRequestType().
|
virtualinherited |
Add my content into a DOMElement.
Reimplemented in nidas::core::DSMSensor, nidas::core::Variable, nidas::core::ServerSocket, nidas::core::SampleTag, nidas::core::Site, nidas::core::Project, and nidas::core::DSMConfig.
Referenced by nidas::core::ServerSocket::toDOMParent().
|
virtualinherited |
Create a DOMElement and append it to the parent.
Reimplemented in nidas::core::DSMSensor, nidas::core::Variable, nidas::core::ServerSocket, nidas::core::SampleTag, nidas::core::Site, nidas::core::Project, and nidas::core::DSMConfig.
|
inlinevirtual |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection.
The returned IOChannel should be used to read/write. Calling this method will fail with an assert.
Implements nidas::core::IOChannel.
|
inlinevirtual |
A McSocket shouldn't be used to do any actual reads or writes, it just sets up the connection.
The returned IOChannel should be used to read/write. Calling this method will fail with an assert.
Implements nidas::core::IOChannel.
|
inlinevirtualinherited |
Should the NIDAS header be written to this IOChannel? NIDAS headers are not written to DatagramSockets, because there is no guarantee they will get there.
Reimplemented in nidas::core::DatagramSocket.
Referenced by nidas::dynld::SampleInputStream::setIOChannel().
|
private |
Referenced by isRequester(), and setRequester().
|
private |
|
protected |
Referenced by connected().
|
private |
Referenced by connect(), connected(), getKeepAliveIdleSecs(), and setKeepAliveIdleSecs().
|
protected |
Referenced by close(), connect(), getInet4McastSocketAddress(), getRequestType(), setInet4McastSocketAddress(), and setRequestType().
|
private |
Referenced by isNewInput().
|
private |
Referenced by isNonBlocking(), and setNonBlocking().