FrameEndpoint Class Reference

#include <FrameEndpoint.h>

Inheritance diagram for FrameEndpoint:

Collaboration diagram for FrameEndpoint:

Public Member Functions
	FrameEndpoint (boost::asio::io_service &a_IOService, boost::asio::ip::tcp::socket &a_TcpSocket, uint8_t a_FrameTypeMask=0xFF)
	~FrameEndpoint ()
void	ResetFrameFactories (uint8_t a_FrameTypeMask=0xFF)
void	RegisterFrameFactory (unsigned char a_FrameType, std::function< std::shared_ptr< Frame >(void)> a_FrameFactory)
bool	GetWasStarted () const
void	Start ()
void	Shutdown ()
void	Close ()
void	TriggerNextFrame ()
bool	SendFrame (const Frame &a_Frame, std::function< void()> a_OnSendDoneCallback=nullptr)
void	SetOnFrameCallback (std::function< bool(std::shared_ptr< Frame >)> a_OnFrameCallback)
void	SetOnClosedCallback (std::function< void()> a_OnClosedCallback)

Detailed Description

Definition at line 48 of file FrameEndpoint.h.

Constructor & Destructor Documentation

FrameEndpoint::FrameEndpoint ( boost::asio::io_service &  a_IOService, boost::asio::ip::tcp::socket &  a_TcpSocket, uint8_t  a_FrameTypeMask = 0xFF  )

inline

Definition at line 51 of file FrameEndpoint.h.

FrameEndpoint::~FrameEndpoint ( )

inline

Definition at line 64 of file FrameEndpoint.h.

Here is the call graph for this function:

Member Function Documentation

void FrameEndpoint::Close ( )

inline

Definition at line 111 of file FrameEndpoint.h.

Here is the caller graph for this function:

bool FrameEndpoint::GetWasStarted ( ) const

inline

Definition at line 85 of file FrameEndpoint.h.

void FrameEndpoint::RegisterFrameFactory ( unsigned char  a_FrameType, std::function< std::shared_ptr< Frame >(void)>  a_FrameFactory  )

inline

Definition at line 77 of file FrameEndpoint.h.

void FrameEndpoint::ResetFrameFactories ( uint8_t  a_FrameTypeMask = 0xFF )

inline

Definition at line 71 of file FrameEndpoint.h.

bool FrameEndpoint::SendFrame ( const Frame &  a_Frame, std::function< void()>  a_OnSendDoneCallback = nullptr  )

inline

Definition at line 146 of file FrameEndpoint.h.

Here is the call graph for this function:

void FrameEndpoint::SetOnClosedCallback ( std::function< void()>  a_OnClosedCallback )

inline

Definition at line 177 of file FrameEndpoint.h.

Here is the call graph for this function:

void FrameEndpoint::SetOnFrameCallback ( std::function< bool(std::shared_ptr< Frame >)>  a_OnFrameCallback )

inline

Definition at line 173 of file FrameEndpoint.h.

void FrameEndpoint::Shutdown ( )

inline

Definition at line 107 of file FrameEndpoint.h.

void FrameEndpoint::Start ( )

inline

Definition at line 89 of file FrameEndpoint.h.

Here is the call graph for this function:

void FrameEndpoint::TriggerNextFrame ( )

inline

Definition at line 123 of file FrameEndpoint.h.

Here is the caller graph for this function:

---

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

• libs/framing/src/FrameEndpoint.h