Ocean::Network::ConnectionlessServer Class Reference
This class is the base class for all connectionless server. More...
Inheritance diagram for Ocean::Network::ConnectionlessServer:
Public Types | |
| typedef Callback< void, const Address4 &, const Port &, const void *, const size_t > | ReceiveCallback |
| Definition of a data callback function. More... | |
 Public Types inherited from Ocean::Network::Socket | |
| enum | SocketResult { SR_SUCCEEDED = 0 , SR_FAILED , SR_BUSY , SR_NOT_CONNECTED } |
| Definition of individual result values. More... | |
| typedef SOCKET | SocketId |
| Definition of a socket id. More... | |
| typedef int | SocketId |
| Definition of a socket id. More... | |
| typedef std::vector< uint8_t > | Buffer |
| Definition of a vector holding 8 bit values. More... | |
Public Member Functions | |
| ~ConnectionlessServer () override | |
| Destructs a connectionless server object. More... | |
| void | setReceiveCallback (const ReceiveCallback &callback) |
| Sets the receive data callback function. More... | |
| Public Member Functions inherited from Ocean::Network::ConnectionlessClient | |
| SocketResult | send (const Address4 &address, const Port &port, const void *data, const size_t size) |
| Sends data to a specified recipient. More... | |
| SocketResult | send (const Address4 &address, const Port &port, const std::string &message) |
| Sends a message to a specified recipient. More... | |
| Public Member Functions inherited from Ocean::Network::Socket | |
| virtual | ~Socket () |
| Destructs a socket object. More... | |
| SocketId | id () const |
| Returns the socket id. More... | |
| Address4 | address () const |
| Returns the own address of this socket. More... | |
| Port | port () const |
| Returns the own port of this socket. More... | |
| virtual bool | setAddress (const Address4 &address) |
| Sets the own address of this socket. More... | |
| virtual bool | setPort (const Port &port) |
| Sets the own port of this socket. More... | |
| operator bool () const | |
| Returns whether this socket is valid. More... | |
| Public Member Functions inherited from Ocean::Network::Server | |
| ~Server () override | |
| Destructs a server object. More... | |
| virtual bool | start () |
| Starts the server. More... | |
| virtual bool | stop () |
| Stops the server. More... | |
Protected Member Functions | |
| ConnectionlessServer () | |
| Creates a new connectionless server object. More... | |
| bool | onScheduler () override |
| The scheduler event function. More... | |
| Protected Member Functions inherited from Ocean::Network::ConnectionlessClient | |
| ConnectionlessClient () | |
| Creates a new connectionless client object. More... | |
| Protected Member Functions inherited from Ocean::Network::Client | |
| Client () | |
| Creates a new client. More... | |
| ~Client () override | |
| Destructs a client. More... | |
| Protected Member Functions inherited from Ocean::Network::Socket | |
| Socket () | |
| Creates a new socket object. More... | |
| Socket (const Socket &object)=delete | |
| Disabled copy constructor. More... | |
| bool | setBlockingMode (const bool blocking) |
| Sets the blocking mode of this socket. More... | |
| size_t | maximalMessageSize (const size_t defaultSize=65536) |
| Returns the maximal message size in bytes. More... | |
| bool | releaseSocket () |
| Releases the socket. More... | |
| Socket & | operator= (const Socket &object)=delete |
| Disabled copy operator. More... | |
| Protected Member Functions inherited from Ocean::Network::Server | |
| Server () | |
| Creates a new server object. More... | |
Protected Attributes | |
| ReceiveCallback | receiveCallback_ |
| Data callback function called on new message arrivals. More... | |
| Protected Attributes inherited from Ocean::Network::Client | |
| Buffer | socketBuffer_ |
| The socket buffer of this client. More... | |
| Protected Attributes inherited from Ocean::Network::Socket | |
| SocketId | socketId_ = invalidSocketId() |
| Socket id. More... | |
| Lock | lock_ |
| Socket lock. More... | |
| NetworkResource | networkResource_ |
| The network resource object. More... | |
| Protected Attributes inherited from Ocean::Network::Server | |
| Buffer | buffer_ |
| The socket buffer of this server. More... | |
| bool | schedulerIsActive_ = false |
| True, if the server scheduler is active. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Ocean::Network::Socket | |
| static constexpr SocketId | invalidSocketId () |
| Returns an invalid socket id. More... | |
| static bool | setBlockingMode (const SocketId socketId, const bool blocking) |
| Sets the blocking mode of a socket. More... | |
Detailed Description
This class is the base class for all connectionless server.
Member Typedef Documentation
◆ ReceiveCallback
| typedef Callback<void, const Address4&, const Port&, const void*, const size_t> Ocean::Network::ConnectionlessServer::ReceiveCallback |
Definition of a data callback function.
Parameter 0 provides the address of the sender Parameter 1 provides the port of the sender Parameter 2 provides the buffer that has been received, must be copied Parameter 3 provides the size of the received buffer, in bytes
Constructor & Destructor Documentation
◆ ~ConnectionlessServer()
|
override |
Destructs a connectionless server object.
◆ ConnectionlessServer()
|
protected |
Creates a new connectionless server object.
Member Function Documentation
◆ onScheduler()
|
overrideprotectedvirtual |
◆ setReceiveCallback()
|
inline |
Sets the receive data callback function.
- Parameters
-
callback The callback function to be called if a new message arrives
Field Documentation
◆ receiveCallback_
|
protected |
Data callback function called on new message arrivals.
The documentation for this class was generated from the following file:
