ClassicFrame Class Reference

#include <classic_frame.h>

Static Public Member Functions
static stdx::expected< void, std::error_code >	ensure_has_msg_prefix (Channel *src_channel, ClassicProtocolState *src_protocol)
	ensure message has a frame-header and msg-type. More...
static stdx::expected< void, std::error_code >	ensure_has_full_frame (Channel *src_channel, ClassicProtocolState *src_protocol)
static stdx::expected< size_t, std::error_code >	recv_frame_sequence (Channel *src_channel, ClassicProtocolState *src_protocol)
	recv a full message sequence into the channel's recv_plain_buffer() More...
static stdx::expected< void, std::error_code >	ensure_server_greeting (Channel *src_channel, ClassicProtocolState *src_protocol)
static stdx::expected< void, std::error_code >	ensure_frame_header (Channel *src_channel, ClassicProtocolState *src_protocol)
	ensure current_frame() has a current frame-info. More...
template<class T >
static constexpr uint8_t	cmd_byte ()
template<class Msg >
static stdx::expected< Msg, std::error_code >	recv_msg (Channel *src_channel, ClassicProtocolState *src_protocol, classic_protocol::capabilities::value_type caps)
	receive a classic protocol message frame from a channel. More...
template<class Msg >
static stdx::expected< Msg, std::error_code >	recv_msg (Channel *src_channel, ClassicProtocolState *src_protocol)
template<class Msg >
static stdx::expected< size_t, std::error_code >	send_msg (Channel *dst_channel, ClassicProtocolState *dst_protocol, Msg msg, classic_protocol::capabilities::value_type caps)
template<class Msg >
static stdx::expected< size_t, std::error_code >	send_msg (Channel *dst_channel, ClassicProtocolState *dst_protocol, Msg msg)

Member Function Documentation

cmd_byte()

template<class T >

static constexpr uint8_t ClassicFrame::cmd_byte ( )

inlinestaticconstexpr

ensure_frame_header()

stdx::expected< void, std::error_code > ClassicFrame::ensure_frame_header ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

static

ensure current_frame() has a current frame-info.

Postcondition

after success returned, src_protocol->current_frame() has a frame decoded.

ensure_has_full_frame()

stdx::expected< void, std::error_code > ClassicFrame::ensure_has_full_frame ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

static

ensure_has_msg_prefix()

stdx::expected< void, std::error_code > ClassicFrame::ensure_has_msg_prefix ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

static

ensure message has a frame-header and msg-type.

Return values

true	if src-protocol's recv-buffer has frame-header and msg-type.

ensure_server_greeting()

static stdx::expected< void, std::error_code > ClassicFrame::ensure_server_greeting ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

static

recv_frame_sequence()

stdx::expected< size_t, std::error_code > ClassicFrame::recv_frame_sequence ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

static

recv a full message sequence into the channel's recv_plain_buffer()

recv_msg() [1/2]

template<class Msg >

static stdx::expected< Msg, std::error_code > ClassicFrame::recv_msg ( Channel *  src_channel, ClassicProtocolState *  src_protocol  )

inlinestatic

recv_msg() [2/2]

template<class Msg >

static stdx::expected< Msg, std::error_code > ClassicFrame::recv_msg ( Channel *  src_channel, ClassicProtocolState *  src_protocol, classic_protocol::capabilities::value_type  caps  )

inlinestatic

receive a classic protocol message frame from a channel.

send_msg() [1/2]

template<class Msg >

static stdx::expected< size_t, std::error_code > ClassicFrame::send_msg ( Channel *  dst_channel, ClassicProtocolState *  dst_protocol, Msg  msg  )

inlinestatic

send_msg() [2/2]

template<class Msg >

static stdx::expected< size_t, std::error_code > ClassicFrame::send_msg ( Channel *  dst_channel, ClassicProtocolState *  dst_protocol, Msg  msg, classic_protocol::capabilities::value_type  caps  )

inlinestatic

---

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

• router/src/routing/src/classic_frame.h
• router/src/routing/src/classic_frame.cc