mcx::comm

  2 minute read  

mcx::comm

Classes

Name
class mcx::comm::Authorization
class mcx::comm::AuthorizationBase
class mcx::comm::BasePublisher
class mcx::comm::BaseRequestReply
struct mcx::comm::ConnectionData
struct mcx::comm::ParameterContainer
struct mcx::comm::GroupContainer
class mcx::comm::GroupManager
class mcx::comm::GroupRawPublisher
class mcx::comm::GroupRawPublisher0
class mcx::comm::GroupRawPublisher1
class mcx::comm::ParamItr
struct mcx::comm::ParamTreeHookContainer
struct mcx::comm::ParameterTreeMsg
struct mcx::comm::ParameterTreeInfo
class mcx::comm::ParameterTree
class mcx::comm::PosixSpawn
class mcx::comm::Publisher
struct mcx::comm::PipeEvent
struct mcx::comm::Work
class mcx::comm::RequestReply
struct mcx::comm::RequestParam
struct mcx::comm::RequestParamList
struct mcx::comm::ParamMsgHookContainer
struct mcx::comm::ParamListMsgHookContainer
struct mcx::comm::GetParamListMsgHookContainer
struct mcx::comm::SetParamMsgHookContainer
struct mcx::comm::OverwriteParamMsgHookContainer
struct mcx::comm::SetParamListMsgHookContainer
class mcx::comm::RPCMotorcortex
class mcx::comm::RPCProcessor
struct mcx::comm::RequestMsg
struct mcx::comm::ReplyMsg
struct mcx::comm::ReplyHandle

Types

Name
enum class ConnectionDir { BIND_TO_LOCAL, CONNECT_TO_REMOTE}
enum class ProtocolType { SINGLE_TIMESTAMP, MULTI_TIMESTAMP}
enum class RequestFlags { USER_HAS_CONTROL = 1}
enum class ReplyState { EMPTY = 0, PROCESSING, READY, ERROR, TIMEOUT}
typedef std::vector< ParameterContainer > ParameterMap
typedef std::map< std::string, GroupContainer > GroupMap
using std::map< uint32_t, RPCProcessor * > RPCProcessorMap
typedef std::set< uint32_t > MsgHashSet

Functions

Name
std::string generate_url(const ConnectionData & data, const std::string & port)
bool initParamTreeHook(pb_ostream_s * stream, const pb_field_t * field, void *const * arg)
ReplyMsg allocateMsgMem(size_t size)
ReplyMsg duplicateMsgMem(ReplyMsg msg)
ReplyMsg reallocateMsgMem(ReplyMsg msg, size_t size)
void deallocateMsgMem(ReplyMsg msg_mem)
std::string sockAddrToStr(const nng_sockaddr & sock_addr)

Attributes

Name
constexpr auto MAX_PARAM_NUMBER_IN_GROUP
constexpr auto TIMESTAMP_SIZE
constexpr auto GP_ID_HEADER_SIZE_BYTES
constexpr char MODULE_TYPE

Types Documentation

enum ConnectionDir

Enumerator Value Description
BIND_TO_LOCAL
CONNECT_TO_REMOTE

enum ProtocolType

Enumerator Value Description
SINGLE_TIMESTAMP
MULTI_TIMESTAMP

enum RequestFlags

Enumerator Value Description
USER_HAS_CONTROL 1

enum ReplyState

Enumerator Value Description
EMPTY 0
PROCESSING
READY
ERROR
TIMEOUT

typedef ParameterMap

typedef std::vector<ParameterContainer> mcx::comm::ParameterMap;

typedef GroupMap

typedef std::map<std::string, GroupContainer> mcx::comm::GroupMap;

using RPCProcessorMap

using mcx::comm::RPCProcessorMap = typedef std::map<uint32_t, RPCProcessor*>;

typedef MsgHashSet

typedef std::set<uint32_t> mcx::comm::MsgHashSet;

Functions Documentation

function generate_url

inline std::string generate_url(
    const ConnectionData & data,
    const std::string & port
)

function initParamTreeHook

bool initParamTreeHook(
    pb_ostream_s * stream,
    const pb_field_t * field,
    void *const * arg
)

function allocateMsgMem

ReplyMsg allocateMsgMem(
    size_t size
)

function duplicateMsgMem

ReplyMsg duplicateMsgMem(
    ReplyMsg msg
)

function reallocateMsgMem

ReplyMsg reallocateMsgMem(
    ReplyMsg msg,
    size_t size
)

function deallocateMsgMem

void deallocateMsgMem(
    ReplyMsg msg_mem
)

function sockAddrToStr

std::string sockAddrToStr(
    const nng_sockaddr & sock_addr
)

Attributes Documentation

variable MAX_PARAM_NUMBER_IN_GROUP

constexpr auto MAX_PARAM_NUMBER_IN_GROUP = 512;

variable TIMESTAMP_SIZE

constexpr auto TIMESTAMP_SIZE = sizeof(utils::Timespec64);

variable GP_ID_HEADER_SIZE_BYTES

constexpr auto GP_ID_HEADER_SIZE_BYTES = 4;

variable MODULE_TYPE

static constexpr char MODULE_TYPE = ".type";

Updated on 2022-04-05 at 16:21:26 +0200