websocket::EventRouter< SessionType > Class Template Reference

A Socket.IO style event router for WebSockets with Room and Session support. More...

#include <EventRouter.hpp>

Classes
struct	RoomBroadcaster

Public Types
using	SocketPtr = std::shared_ptr< EventSocket< SessionType > >

Public Member Functions
template<typename PayloadType >
void	on (const std::string &event, std::function< void(EventSocket< SessionType > &, const PayloadType &)> handler)
void	on (const std::string &event, std::function< void(EventSocket< SessionType > &)> handler)
	Registers an untyped event handler (no data expected).
void	on_connect (std::function< void(EventSocket< SessionType > &)> handler)
	Registers a connection handler.
void	on_disconnect (std::function< void(EventSocket< SessionType > &)> handler)
	Registers a disconnection handler.
void	attach (server::App &app, const std::string &path)
	Attaches this EventRouter to the Orbit App at a specific path.
RoomBroadcaster	to (const std::string &room)
void	join_room (const std::string &id, const std::string &room)
void	leave_room (const std::string &id, const std::string &room)
void	broadcast_to_room (const std::string &room, const std::string &msg)

Detailed Description

template<typename SessionType>
class websocket::EventRouter< SessionType >

A Socket.IO style event router for WebSockets with Room and Session support.

Member Typedef Documentation

SocketPtr

template<typename SessionType >

using websocket::EventRouter< SessionType >::SocketPtr = std::shared_ptr<EventSocket<SessionType> >

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

Member Function Documentation

attach()

template<typename SessionType >

void websocket::EventRouter< SessionType >::attach ( server::App &  app, const std::string &  path  )

inline

Attaches this EventRouter to the Orbit App at a specific path.

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

broadcast_to_room()

template<typename SessionType >

void websocket::EventRouter< SessionType >::broadcast_to_room ( const std::string &  room, const std::string &  msg  )

inline

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

join_room()

template<typename SessionType >

void websocket::EventRouter< SessionType >::join_room ( const std::string &  id, const std::string &  room  )

inline

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

leave_room()

template<typename SessionType >

void websocket::EventRouter< SessionType >::leave_room ( const std::string &  id, const std::string &  room  )

inline

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

on() [1/2]

template<typename SessionType >

void websocket::EventRouter< SessionType >::on ( const std::string &  event, std::function< void(EventSocket< SessionType > &)>  handler  )

inline

Registers an untyped event handler (no data expected).

on() [2/2]

template<typename SessionType >

template<typename PayloadType >

void websocket::EventRouter< SessionType >::on ( const std::string &  event, std::function< void(EventSocket< SessionType > &, const PayloadType &)>  handler  )

inline

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

on_connect()

template<typename SessionType >

void websocket::EventRouter< SessionType >::on_connect ( std::function< void(EventSocket< SessionType > &)>  handler )

inline

Registers a connection handler.

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

on_disconnect()

template<typename SessionType >

void websocket::EventRouter< SessionType >::on_disconnect ( std::function< void(EventSocket< SessionType > &)>  handler )

inline

Registers a disconnection handler.

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

to()

template<typename SessionType >

RoomBroadcaster websocket::EventRouter< SessionType >::to ( const std::string &  room )

inline

Examples

/home/runner/work/orbit-framework/orbit-framework/include/orbit/websocket/EventRouter.hpp.

---

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

• include/orbit/websocket/EventRouter.hpp