TransportFactory(std::string id)ctor
id- Topology wide unique id, usually the device id.
API · fair::mq
TransportFactoryclass
No comment in the header yet.
Functions
TransportFactory(const TransportFactory&) = deleteNo comment in the header yet.
TransportFactory(TransportFactory&&) = deleteNo comment in the header yet.
TransportFactory& operator=(const TransportFactory&) = deleteNo comment in the header yet.
TransportFactory& operator=(TransportFactory&&) = deleteNo comment in the header yet.
auto GetId() const -> const std::stringNo comment in the header yet.
ChannelResource* GetMemoryResource()Get a pointer to the associated polymorphic memory resource.
operator ChannelResource *()No comment in the header yet.
virtual MessagePtr CreateMessage() = 0Create empty Message (for receiving)
- Returns
- pointer to Message
virtual MessagePtr CreateMessage(Alignment alignment) = 0Create empty Message (for receiving), align received buffer to specified alignment.
alignment- alignment to align received buffer to
- Returns
- pointer to Message
virtual MessagePtr CreateMessage(size_t size) = 0Create new Message of specified size.
size- message size
- Returns
- pointer to Message
virtual MessagePtr CreateMessage(size_t size, Alignment alignment) = 0Create new Message of specified size and alignment.
size- message size
alignment- message alignment
- Returns
- pointer to Message
virtual MessagePtr CreateMessage(
void* data,
size_t size,
FreeFn* ffn,
void* hint = nullptr
) = 0Create new Message with user provided buffer and size.
data- pointer to user provided buffer
size- size of the user provided buffer
ffn- callback, called when the message is transfered (and can be deleted)
obj- optional helper pointer that can be used in the callback
- Returns
- pointer to Message
virtual MessagePtr CreateMessage(
UnmanagedRegionPtr& unmanagedRegion,
void* data,
size_t size,
void* hint = nullptr
) = 0create a message with the buffer located within the corresponding unmanaged region
unmanagedRegion- the unmanaged region that this message buffer belongs to
data- message buffer (must be within the region - checked at runtime by the transport)
size- size of the message
hint- optional parameter, returned to the user in the RegionCallback
virtual SocketPtr CreateSocket(
const std::string& type,
const std::string& name
) = 0Create a socket.
virtual PollerPtr CreatePoller(const std::vector<Channel>& channels) const = 0Create a poller for a single channel (all subchannels)
virtual PollerPtr CreatePoller(const std::vector<Channel*>& channels) const = 0Create a poller for specific channels.
virtual PollerPtr CreatePoller(
const std::unordered_map<std::string, std::vector<Channel>>& channelsMap,
const std::vector<std::string>& channelList
) const = 0Create a poller for specific channels (all subchannels)
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
RegionCallback callback = nullptr,
const std::string& path = "",
int flags = 0,
RegionConfig cfg = RegionConfig()
) = 0Create new UnmanagedRegion.
size- size of the region
callback- callback to be called when a message belonging to this region is no longer needed by the transport
path- optional parameter to pass to the underlying transport
flags- optional parameter to pass to the underlying transport
- Returns
- pointer to UnmanagedRegion
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
RegionBulkCallback bulkCallback = nullptr,
const std::string& path = "",
int flags = 0,
RegionConfig cfg = RegionConfig()
) = 0No comment in the header yet.
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
int64_t userFlags,
RegionCallback callback = nullptr,
const std::string& path = "",
int flags = 0,
RegionConfig cfg = RegionConfig()
) = 0Create new UnmanagedRegion.
size- size of the region
userFlags- flags to be stored with the region, have no effect on the transport, but can be retrieved from the region by the user
callback- callback to be called when a message belonging to this region is no longer needed by the transport
path- optional parameter to pass to the underlying transport
flags- optional parameter to pass to the underlying transport
- Returns
- pointer to UnmanagedRegion
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
int64_t userFlags,
RegionBulkCallback bulkCallback = nullptr,
const std::string& path = "",
int flags = 0,
RegionConfig cfg = RegionConfig()
) = 0No comment in the header yet.
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
RegionCallback callback,
RegionConfig cfg
) = 0Create new UnmanagedRegion.
size- size of the region
callback- callback to be called when a message belonging to this region is no longer needed by the transport
cfg- region configuration
- Returns
- pointer to UnmanagedRegion
virtual UnmanagedRegionPtr CreateUnmanagedRegion(
size_t size,
RegionBulkCallback bulkCallback,
RegionConfig cfg
) = 0Create new UnmanagedRegion.
size- size of the region
bulkCallback- callback to be called when message(s) belonging to this region is no longer needed by the transport
cfg- region configuration
- Returns
- pointer to UnmanagedRegion
virtual void SubscribeToRegionEvents(RegionEventCallback callback) = 0Subscribe to region events (creation, destruction, ...)
callback- the callback that is called when a region event occurs
virtual bool SubscribedToRegionEvents() = 0Check if there is an active subscription to region events.
- Returns
- true/false
virtual void UnsubscribeFromRegionEvents() = 0Unsubscribe from region events.
virtual std::vector<RegionInfo> GetRegionInfo() = 0No comment in the header yet.
virtual Transport GetType() const = 0Get transport type.
virtual void Interrupt() = 0No comment in the header yet.
virtual void Resume() = 0No comment in the header yet.
virtual void Reset() = 0No comment in the header yet.
virtual ~TransportFactory() = defaultNo comment in the header yet.
template<typename T>
MessagePtr NewSimpleMessage(const T& data)No comment in the header yet.
template<std::size_t N>
MessagePtr NewSimpleMessage(const char(&) data[N])No comment in the header yet.
MessagePtr NewSimpleMessage(const std::string& str)No comment in the header yet.
template<typename T>
MessagePtr NewStaticMessage(const T& data)No comment in the header yet.
MessagePtr NewStaticMessage(const std::string& str)No comment in the header yet.
Static functions
static auto CreateTransportFactory(
const std::string& type,
const std::string& id = "",
const ProgOptions* config = nullptr
) -> std::shared_ptr< TransportFactory >No comment in the header yet.
static void NoCleanup(void*, void*)No comment in the header yet.
template<typename T>
static void SimpleMsgCleanup(void*, void* obj)No comment in the header yet.