API Documentation
Loading...
Searching...
No Matches
SocketIO Class Reference

Provides the ability to communicate over a network using SocketIO (https://socket.io/docs/v4/) More...

#include <SocketIO.h>

Inheritance diagram for SocketIO:
[legend]
Collaboration diagram for SocketIO:
[legend]

Public Member Functions

void addChannel (DynamicPointer< SocketIOChannel > &channel)
 
void close ()
 
bool connect (const String &url="http://ndevr.org:3000")
 
DynamicPointer< SocketIOChannelcreateChannel (const String &name, std::function< void(const char *data, uint04 size)> data_callback, UUID target=Constant< UUID >::Invalid)
 
DynamicPointer< SocketIOChannelcreateChannel (const String &name, UUID target=Constant< UUID >::Invalid)
 
bool isConnected () const
 
const Dictionary< UUID, String > & onlineClients () const
 
void removeChannel (DynamicPointer< SocketIOChannel > &channel)
 
void setName (const String &name)
 
void setRunID (const UUID &run_id)
 
const Stringurl () const
 
 ~SocketIO ()
 

Static Public Member Functions

static DynamicPointer< SocketIOGetSocketIO (const String &url="http://ndevr.org:3000")
 

Protected Member Functions

 SocketIO (QObject *parent=0)
 

Detailed Description

Provides the ability to communicate over a network using SocketIO (https://socket.io/docs/v4/)


Constructor & Destructor Documentation

◆ SocketIO()

SocketIO ( QObject * parent = 0)
explicitprotected

◆ ~SocketIO()

~SocketIO ( )

Member Function Documentation

◆ addChannel()

void addChannel ( DynamicPointer< SocketIOChannel > & channel)

◆ close()

void close ( )

◆ connect()

bool connect ( const String & url = "http://ndevr.org:3000")

◆ createChannel() [1/2]

DynamicPointer< SocketIOChannel > createChannel ( const String & name,
std::function< void(const char *data, uint04 size)> data_callback,
UUID target = ConstantUUID >::Invalid )

◆ createChannel() [2/2]

DynamicPointer< SocketIOChannel > createChannel ( const String & name,
UUID target = ConstantUUID >::Invalid )

◆ GetSocketIO()

static DynamicPointer< SocketIO > GetSocketIO ( const String & url = "http://ndevr.org:3000")
static

◆ isConnected()

bool isConnected ( ) const
inline

◆ onlineClients()

const Dictionary< UUID, String > & onlineClients ( ) const

◆ removeChannel()

void removeChannel ( DynamicPointer< SocketIOChannel > & channel)

◆ setName()

void setName ( const String & name)

◆ setRunID()

void setRunID ( const UUID & run_id)

◆ url()

const String & url ( ) const
inline

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