Skip to content
v1.11dev
GitHub

API · fair::mq

Channelclass

#include <fairmq/Channel.h>fairmq/Channel.h:36GitHub ↗

Wrapper class for Socket and related methods.

The class is not thread-safe.

Nested types

Functions

Channel

Channel.h:52
Channel(
    const std::string& type,
    const std::string& method,
    const std::string& address
)

Constructor

type
Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/)
method
Socket method (bind/connect)
address
Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")

Channel

Channel.h:66
Channel(
    std::string name,
    std::string type,
    std::string method,
    std::string address,
    std::shared_ptr<TransportFactory> factory
)

Constructor

name
Channel name
type
Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/)
method
Socket method (bind/connect)
address
Network address to bind/connect to (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")
factory
TransportFactory

Bind

Channel.h:97
bool Bind(const std::string& address)

No comment in the header yet.

GetName

Channel.h:113
std::string GetName() const

Get channel name

Returns
Returns full channel name (e.g. "data[0]")

GetPrefix

Channel.h:117
std::string GetPrefix() const

Get channel prefix

Returns
Returns channel prefix (e.g. "data" in "data[0]")

GetIndex

Channel.h:126
std::string GetIndex() const

Get channel index

Returns
Returns channel index (e.g. 0 in "data[0]")

GetType

Channel.h:136
std::string GetType() const

Get socket type

Returns
Returns socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/)

GetMethod

Channel.h:140
std::string GetMethod() const

Get socket method

Returns
Returns socket method (bind/connect)

GetAddress

Channel.h:144
std::string GetAddress() const

Get socket address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")

Returns
Returns socket address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")

GetTransportName

Channel.h:148
std::string GetTransportName() const

Get channel transport name ("default", "zeromq" or "shmem")

Returns
Returns channel transport name (e.g. "default", "zeromq" or "shmem")

GetSndBufSize

Channel.h:156
int GetSndBufSize() const

Get socket send buffer size (in number of messages)

Returns
Returns socket send buffer size (in number of messages)

GetRcvBufSize

Channel.h:160
int GetRcvBufSize() const

Get socket receive buffer size (in number of messages)

Returns
Returns socket receive buffer size (in number of messages)

GetSndKernelSize

Channel.h:164
int GetSndKernelSize() const

Get socket kernel transmit send buffer size (in bytes)

Returns
Returns socket kernel transmit send buffer size (in bytes)

GetRcvKernelSize

Channel.h:168
int GetRcvKernelSize() const

Get socket kernel transmit receive buffer size (in bytes)

Returns
Returns socket kernel transmit receive buffer size (in bytes)

GetSndTimeout

Channel.h:172
int GetSndTimeout() const

Get socket default send timeout (in ms)

Returns
Returns socket default send timeout (in ms)

GetRcvTimeout

Channel.h:176
int GetRcvTimeout() const

Get socket default receive timeout (in ms)

Returns
Returns socket default receive timeout (in ms)

GetLinger

Channel.h:180
int GetLinger() const

Get linger duration (in milliseconds)

Returns
Returns linger duration (in milliseconds)

GetRateLogging

Channel.h:184
int GetRateLogging() const

Get socket rate logging interval (in seconds)

Returns
Returns socket rate logging interval (in seconds)

GetAutoBind

Channel.h:196
bool GetAutoBind() const

Set automatic binding (pick random port if bind fails)

Returns
true/false, true if automatic binding is enabled

UpdateType

Channel.h:212
void UpdateType(const std::string& type)

Set socket type

type
Socket type (push/pull/pub/sub/spub/xsub/pair/req/rep/dealer/router/)

UpdateAddress

Channel.h:220
void UpdateAddress(const std::string& address)

Set socket address

Socket
address (e.g. "tcp://127.0.0.1:5555" or "ipc://abc")

UpdateTransport

Channel.h:224
void UpdateTransport(const std::string& transport)

Set channel transport

transport
transport string ("default", "zeromq" or "shmem")

UpdateLinger

Channel.h:252
void UpdateLinger(int duration)

Set linger duration (in milliseconds)

duration
linger duration (in milliseconds)

UpdateAutoBind

Channel.h:268
void UpdateAutoBind(bool autobind)

Set automatic binding (pick random port if bind fails)

autobind
true/false, true to enable automatic binding

IsValid

Channel.h:272
bool IsValid() const

Checks if the configured channel settings are valid (checks the validity parameter, without running full validation (as oposed to ValidateChannel()))

Returns
true if channel settings are valid, false otherwise.

Validate

Channel.h:276
bool Validate()

Validates channel configuration

Returns
true if channel settings are valid, false otherwise.

Send

templateChannel.h:299
template<typename M, typename... Timeout>
std::enable_if_t<is_transferrable<M>::value, int64_t> Send(
    M& m,
    Timeout&&... sndTimeoutMs
)

Send message(s) to the socket queue.

m
reference to MessagePtr/Parts/vector<MessagePtr>
sndTimeoutMs
send timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send). If not provided, default timeout will be taken.
Returns
Number of bytes that have been queued, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)

Receive

templateChannel.h:323
template<typename M, typename... Timeout>
std::enable_if_t<is_transferrable<M>::value, int64_t> Receive(
    M& m,
    Timeout&&... rcvTimeoutMs
)

Receive message(s) from the socket queue.

m
reference to MessagePtr/Parts/vector<MessagePtr>
rcvTimeoutMs
receive timeout in ms. -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive). If not provided, default timeout will be taken.
Returns
Number of bytes that have been received, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change)

Static data members

Friends