BMA Server Framework
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
core::UDPServerSocket Class Reference

#include <UDPServerSocket.h>

Inheritance diagram for core::UDPServerSocket:
Inheritance graph
[legend]
Collaboration diagram for core::UDPServerSocket:
Collaboration graph
[legend]

Public Member Functions

 UDPServerSocket (EPoll &ePoll, std::string url, short int port, std::string commandName)
 
- Public Member Functions inherited from core::UDPSocket
 UDPSocket (EPoll &ePoll)
 
- Public Member Functions inherited from core::Socket
 Socket (EPoll &ePoll)
 
void setDescriptor (int descriptor)
 Set the descriptor for the socket.
 
int getDescriptor ()
 Get the descriptor for the socket.
 
void eventReceived (struct epoll_event event)
 Parse epoll event and call specified callbacks. More...
 
void write (std::string data)
 
void write (char *buffer, int length)
 
void output (std::stringstream &out)
 
virtual void onRegistered ()
 Called when the socket has finished registering with the epoll processing. More...
 
virtual void onUnregistered ()
 Called when the socket has finished unregistering for the epoll processing. More...
 
void enable (bool mode)
 Enable the socket to read or write based upon buffer.
 
- Public Member Functions inherited from core::Command
virtual bool check (std::string request)
 
virtual int processCommand (std::string request, Session *session)=0
 
virtual void output (Session *session)
 
void setName (std::string name)
 
std::string getName ()
 

Protected Member Functions

void onDataReceived (std::string data) override
 Called when data is received from the socket. More...
 
int processCommand (Session *session)
 
- Protected Member Functions inherited from core::Socket
void setBufferSize (int length)
 
virtual void onConnected ()
 Called when socket is open and ready to communicate. More...
 
virtual void onTLSInit ()
 
void shutdown ()
 
virtual void receiveData (char *buffer, int bufferLength)
 

Protected Attributes

std::vector< Session * > sessions
 
- Protected Attributes inherited from core::Socket
EPollePoll
 
bool shutDown = false
 

Additional Inherited Members

- Public Attributes inherited from core::Socket
class {
bufferSize
 
- Public Attributes inherited from core::Object
std::string name
 
std::string tag
 

Detailed Description

UDPSocket

Manage a socket connection as a UDP server type. Connections to the socket are processed through the session list functionality. A list of sessions is maintained in a vector object.

Member Function Documentation

◆ onDataReceived()

void core::UDPServerSocket::onDataReceived ( std::string  data)
overrideprotectedvirtual

Called when data is received from the socket.

The onDataReceived method is called when the socket has received an event from epoll and there is data ready to be read from the socket. The default handler will pull the data and put it into the streambuf for the socket. EPOLLIN

Parameters
datathe data that has been received from the socket.

Implements core::Socket.


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