Abstract base class for all server types (RemoteLogTCPServer, RemoteLogUDPMulticastServer, etc.) More...
#include <RemoteLogRK.h>
Inheritance diagram for RemoteLogServer:
Public Member Functions | |
| RemoteLogServer () | |
| Base class constructor. Doesn't do anything. | |
| virtual | ~RemoteLogServer () |
| This class is not typically deleted, because you can't unregister one. | |
| virtual void | setup () |
| Perform setup operations. More... | |
| virtual void | loop (size_t &readIndex) |
| Perform loop operations. More... | |
| virtual void | reset () |
| Reset is about to occur, do things like disconnect sockets. More... | |
Protected Member Functions | |
| RemoteLogServer (const RemoteLogServer &)=delete | |
| This class is not copyable. | |
| RemoteLogServer & | operator= (const RemoteLogServer &)=delete |
| This class is not copyable. | |
Detailed Description
Abstract base class for all server types (RemoteLogTCPServer, RemoteLogUDPMulticastServer, etc.)
Member Function Documentation
◆ loop()
|
inlinevirtual |
Perform loop operations.
- Parameters
-
readIndex The read index for this server. Not all servers use this, but for the event server, for example, it prevents all of the events in the buffer from being resent after a reset since the readIndex parameter is preserved in retained memory.
Subclasses can override this if they have tasks to perform at loop time. This is almost common.
Reimplemented in RemoteLogEventServer, and RemoteLogSyslogUDP.
◆ reset()
|
inlinevirtual |
Reset is about to occur, do things like disconnect sockets.
The TCP server uses this to disconnect the sockets, otherwise the clients won't know the server went away and will leave the window open, but never receive any more data.
◆ setup()
|
inlinevirtual |
Perform setup operations.
Subclasses can override this if they have tasks to perform at setup.
The documentation for this class was generated from the following file:
- src/RemoteLogRK.h
