ots::TCPDataListenerProducer Class Reference
Inheritance diagram for ots::TCPDataListenerProducer:
Collaboration diagram for ots::TCPDataListenerProducer:
Public Member Functions | |
| TCPDataListenerProducer (std::string supervisorApplicationUID, std::string bufferUID, std::string processorUID, const ConfigurationTree &theXDAQContextConfigTree, const std::string &configurationPath) | |
| virtual void | startProcessingData (std::string runNumber) override |
| virtual void | stopProcessingData (void) override |
| std::map< std::string, std::string > | getExtraStatus (void) const override |
| Public Member Functions inherited from ots::DataProducer | |
| DataProducer (std::string supervisorApplicationUID, std::string bufferUID, std::string processorUID, unsigned int bufferSize=100) | |
| virtual void | configure (void) |
| Public Member Functions inherited from ots::DataProducerBase | |
| DataProducerBase (const std::string &supervisorApplicationUID, const std::string &bufferUID, const std::string &processorUID, unsigned int bufferSize=100) | |
| virtual void | registerToBuffer (void) |
| mirror DataConsumer::registerToBuffer | |
| template<class D , class H > | |
| int | attachToEmptySubBuffer (D *&data, H *&header) |
| template<class D , class H > | |
| int | setWrittenSubBuffer (void) |
| template<class D , class H > | |
| int | write (const D &buffer) |
| template<class D , class H > | |
| int | write (const D &buffer, const H &header) |
| unsigned int | getBufferSize (void) const |
| Public Member Functions inherited from ots::DataProcessor | |
| DataProcessor (std::string supervisorApplicationUID, std::string bufferUID, std::string processorUID) | |
| virtual void | pauseProcessingData (void) |
| virtual void | resumeProcessingData (void) |
| const std::string & | getProcessorID (void) const |
| Getters. | |
| void | setCircularBuffer (CircularBufferBase *circularBuffer) |
| uint64_t | getStatPackets (void) const |
| uint64_t | getStatBytes (void) const |
| uint64_t | getStatErrors (void) const |
| uint64_t | getStatBusyNanos (void) const |
| Public Member Functions inherited from ots::WorkLoop | |
| WorkLoop (const std::string &name) | |
| void | startWorkLoop (void) |
| bool | stopWorkLoop (void) |
| bool | isActive (void) const |
| Public Member Functions inherited from ots::Configurable | |
| Configurable (const ConfigurationTree &theXDAQContextConfigTree, const std::string &theConfigurationPath) | |
| ConfigurationTree | getSelfNode () const |
| const ConfigurationManager * | getConfigurationManager () const |
| const std::string & | getContextUID () const |
| const std::string & | getApplicationUID () const |
| unsigned int | getApplicationLID () const |
| std::string | getContextAddress () const |
| unsigned int | getContextPort () const |
| Public Member Functions inherited from ots::TCPListenServer | |
| TCPListenServer (unsigned int serverPort, unsigned int maxNumberOfClients=-1) | |
| template<class T > | |
| T | receive () |
| std::string | receivePacket () |
| Length-prefixed packet from a ready client. Same timeout/throw semantics. | |
| Public Member Functions inherited from ots::TCPServerBase | |
| TCPServerBase (unsigned int serverPort, unsigned int maxNumberOfClients=0) | |
| Means as many unsigned allows. | |
| void | startAccept (void) |
| void | shutdownAccept (void) |
| void | broadcastPacket (const char *message, std::size_t length) |
| void | broadcastPacket (const std::string &message) |
| void | broadcast (const char *message, std::size_t length) |
| void | broadcast (const std::string &message) |
| void | broadcast (const std::vector< char > &message) |
| void | broadcast (const std::vector< uint16_t > &message) |
| Public Member Functions inherited from ots::TCPSocket | |
| TCPSocket (int socketId=invalidSocketId) | |
| Designed to be a base class not used used directly. | |
| TCPSocket (TCPSocket &&move) | |
| Moveable but not Copyable. | |
| TCPSocket & | operator= (TCPSocket &&move) |
| void | swap (TCPSocket &other) |
| TCPSocket (TCPSocket const &)=delete | |
| Explicitly deleting copy constructor. | |
| TCPSocket & | operator= (TCPSocket const &)=delete |
| int | getSocketId (void) const |
| void | open (void) |
| void | close (void) |
| void | sendClose (void) |
Protected Member Functions | |
| bool | workLoopThread (toolbox::task::WorkLoop *workLoop) override |
| bool TCPDataListenerProducer::getNextFragment(void) | |
| void | slowWrite (void) |
| void | fastWrite (void) |
| void | sampleSocketBacklog (void) |
| work-loop thread only More... | |
| Protected Member Functions inherited from ots::DataProcessor | |
| void | countPacket (uint64_t bytes) |
| void | countError (void) |
| void | countBusyNanos (uint64_t nanos) |
| Protected Member Functions inherited from ots::WorkLoop | |
| const std::string & | getWorkLoopName (void) const |
| Getters. | |
| Protected Member Functions inherited from ots::TCPListenServer | |
| void | acceptConnections () override |
| TCPReceiverSocket * | waitForReadableClient (std::chrono::milliseconds timeout) |
| Protected Member Functions inherited from ots::TCPServerBase | |
| void | closeClientSocket (int socket) |
| template<class T > | |
| T * | acceptClient (bool blocking=true) |
| void | removeClient (int socketId) |
| Drop a client whose peer has gone away (no shutdown handshake, just close). | |
| std::vector< int > | getClientSocketIds (void) const |
| Snapshot of connected client socket ids, safe to call from any thread. | |
| void | pingActiveClients (void) |
| bool | getAccept () |
Protected Attributes | |
| std::atomic< uint64_t > | statClients_ {0} |
| std::atomic< uint64_t > | statSocketBacklogBytes_ {0} |
| std::chrono::steady_clock::time_point | lastBacklogSample_ {} |
| std::string | data_ |
| For slow write. | |
| std::map< std::string, std::string > | header_ |
| std::string * | dataP_ |
| For fast write. | |
| std::map< std::string, std::string > * | headerP_ |
| std::string | dataType_ |
| unsigned | port_ |
| Protected Attributes inherited from ots::DataProcessor | |
| const std::string | supervisorApplicationUID_ |
| const std::string | bufferUID_ |
| const std::string | processorUID_ |
| CircularBufferBase * | theCircularBuffer_ |
| Protected Attributes inherited from ots::WorkLoop | |
| volatile bool | continueWorkLoop_ |
| Protected Attributes inherited from ots::Configurable | |
| const ConfigurationTree | theXDAQContextConfigTree_ |
| const std::string | theConfigurationPath_ |
| const std::string | theConfigurationRecordName_ |
| Protected Attributes inherited from ots::TCPListenServer | |
| int | lastReceived = -1 |
| Protected Attributes inherited from ots::TCPServerBase | |
| std::mutex | fClientsMutex |
| std::map< int, TCPSocket * > | fConnectedClients |
| std::map< int, std::future< void > > | fConnectedClientsFuture |
| const int | E_SHUTDOWN = 0 |
Additional Inherited Members | |
| Static Protected Attributes inherited from ots::TCPListenServer | |
| static constexpr std::chrono::milliseconds | kPollTimeout {5} |
| Static Protected Attributes inherited from ots::TCPSocket | |
| static constexpr int | invalidSocketId = -1 |
Detailed Description
Definition at line 18 of file TCPDataListenerProducer.h.
Member Function Documentation
◆ getExtraStatus()
|
overridevirtual |
Adds "clients" (connected sockets) and "socketBacklogBytes" (unread bytes waiting in the kernel receive buffers of all clients). Both sampled from the work loop.
Reimplemented from ots::DataProcessor.
Definition at line 182 of file TCPDataListenerProducer_processor.cc.
◆ sampleSocketBacklog()
|
protected |
work-loop thread only
sampleSocketBacklog Called from the work-loop thread. At most twice a second, asks the kernel how many bytes are queued and unread on every connected client socket (FIONREAD). A growing number means the receiver is read-limited.
Definition at line 162 of file TCPDataListenerProducer_processor.cc.
The documentation for this class was generated from the following files:
- otsdaq/otsdaq/DataProcessorPlugins/TCPDataListenerProducer.h
- otsdaq/otsdaq/DataProcessorPlugins/TCPDataListenerProducer_processor.cc
