#include <net.h>
Detailed Description
Network transport operations. The network domain mutex must be held to invoke these methods, unless explicitly stated otherwise.
Field Documentation
◆ xo_bev_deliver_all
| void(* xo_bev_deliver_all) (struct m0_net_transfer_mc *tm) |
Invokes m0_net_buffer_event_post() for all pending events.
Invoked by the m0_net_buffer_event_deliver_all() subroutine. Optional if the synchronous buffer event delivery feature is not supported.
As buffer event delivery takes place without holding the transfer machine mutex, the transport should protect the invocation of this subroutine from synchronous termination of the transfer machine.
◆ xo_bev_deliver_sync
| int(* xo_bev_deliver_sync) (struct m0_net_transfer_mc *tm) |
Invoked by the m0_net_buffer_event_deliver_synchronously() subroutine to request the transport to disable automatic delivery of buffer events. The method is optional and need not be specified if this support is not available. If supported, then the xo_bev_deliver_all() and the xo_bev_pending() operations must be provided.
◆ xo_bev_notify
| void(* xo_bev_notify) (struct m0_net_transfer_mc *tm, struct m0_chan *chan) |
Arranges for the given channel to be signalled when new event arrives.
Invoked by the m0_net_buffer_event_notify() subroutine. Optional if the synchronous buffer event delivery feature is not supported.
◆ xo_bev_pending
| bool(* xo_bev_pending) (struct m0_net_transfer_mc *tm) |
Returns true, iff there are pending events.
Invoked by the m0_net_buffer_event_pending() subroutine. Optional if the synchronous buffer event delivery feature is not supported.
◆ xo_buf_add
| int(* xo_buf_add) (struct m0_net_buffer *nb) |
Initiates an operation on a buffer on the transfer machine's queues.
In the case of buffers added to the M0_NET_QT_ACTIVE_BULK_RECV or M0_NET_QT_ACTIVE_BULK_SEND queues, the method should validate that the buffer size or data length meet the size requirements encoded within the network buffer descriptor m0_net_buffer::nb_desc.
In the case of the buffers added to the M0_NET_QT_PASSIVE_BULK_RECV or M0_NET_QT_PASSIVE_BULK_SEND queues, the method should set the network buffer descriptor in the specified buffer (m0_net_buffer::nb_desc).
The M0_NET_BUF_IN_USE flag will be cleared before invoking the method. This allows the transport to use this flag to defer operations until later, which is useful if buffers are added during transfer machine state transitions.
The M0_NET_BUF_QUEUED flag and the nb_add_time field will be set prior to calling the method.
Serialized using the transfer machine mutex.
- Precondition
- nb->nb_tm != NULL
- See also
- m0_net_buffer_add(), struct m0_net_buffer
◆ xo_buf_del
| void(* xo_buf_del) (struct m0_net_buffer *nb) |
Cancels an operation involving a buffer. The method should cancel the operation involving use of the buffer, as described by the value of the m0_net_buffer.nb_qtype field. The M0_NET_BUF_CANCELLED flag should be set in buffers whose operations get cancelled, so m0_net_buffer_event_post() can enforce the right error status. Serialized using the transfer machine mutex.
- Precondition
- nb->nb_tm != NULL
- m0_net__qtype_is_valid(nb->nb_qtype)
- See also
- m0_net_buffer_del()
◆ xo_buf_deregister
| void(* xo_buf_deregister) (struct m0_net_buffer *nb) |
Deregisters the buffer from the transfer machine.
- See also
- m0_net_buffer_deregister()
◆ xo_buf_register
| int(* xo_buf_register) (struct m0_net_buffer *nb) |
Registers the buffer for use with a transfer machine in the manner indicated by the m0_net_buffer.nb_qtype value.
- See also
- m0_net_buffer_register()
◆ xo_dom_fini
| void(* xo_dom_fini) (struct m0_net_domain *dom) |
◆ xo_dom_init
| int(* xo_dom_init) (const struct m0_net_xprt *xprt, struct m0_net_domain *dom) |
◆ xo_end_point_create
| int(* xo_end_point_create) (struct m0_net_end_point **epp, struct m0_net_transfer_mc *tm, const char *addr) |
Creates an end point with a specific address.
- Parameters
-
epp Returned end point data structure. addr Address string. Could be NULL to indicate dynamic addressing. Do not reference the string after return.
- See also
- m0_net_end_point_create()
◆ xo_get_max_buffer_desc_size
| m0_bcount_t(* xo_get_max_buffer_desc_size) (const struct m0_net_domain *dom) |
◆ xo_get_max_buffer_segment_size
| m0_bcount_t(* xo_get_max_buffer_segment_size) (const struct m0_net_domain *dom) |
Retrieves the maximum buffer segment size.
- Return values
-
size Returns the maximum segment size.
◆ xo_get_max_buffer_segments
| int32_t(* xo_get_max_buffer_segments) (const struct m0_net_domain *dom) |
Retrieves the maximum number of buffer segments.
- Return values
-
num_segs Returns the maximum number of buffer segments.
◆ xo_get_max_buffer_size
| m0_bcount_t(* xo_get_max_buffer_size) (const struct m0_net_domain *dom) |
Retrieves the maximum buffer size (includes all segments).
- Return values
-
size Returns the maximum buffer size.
◆ xo_rpc_max_msg_size
| m0_bcount_t(* xo_rpc_max_msg_size) (struct m0_net_domain *ndom, m0_bcount_t rpc_size) |
◆ xo_rpc_max_recv_msgs
| uint32_t(* xo_rpc_max_recv_msgs) (struct m0_net_domain *ndom, m0_bcount_t rpc_size) |
◆ xo_rpc_max_seg_size
| m0_bcount_t(* xo_rpc_max_seg_size) (struct m0_net_domain *ndom) |
◆ xo_rpc_max_segs_nr
| uint32_t(* xo_rpc_max_segs_nr) (struct m0_net_domain *ndom) |
◆ xo_tm_confine
| int(* xo_tm_confine) (struct m0_net_transfer_mc *tm, const struct m0_bitmap *processors) |
Optional method to set the processor affinity for the threads of a transfer machine. The transfer machine must be initialized but not yet started.
- Parameters
-
processors Processor bitmap.
- Return values
-
-ENOSYS No affinity support available. Implied by a missing method.
◆ xo_tm_fini
| void(* xo_tm_fini) (struct m0_net_transfer_mc *tm) |
Releases resources associated with a transfer machine. The transfer machine will be in the stopped state.
The following fields are of special interest to this method:
- ntm_dom - ntm_xprt_private - The method should free any allocated memory tracked by this pointer.
- See also
- m0_net_tm_fini()
◆ xo_tm_init
| int(* xo_tm_init) (struct m0_net_transfer_mc *tm) |
Performs transport level initialization of the transfer machine.
All fields will be initialized at this time, specifically:
- ntm_dom - ntm_xprt_private - Initialized to NULL. The method can set its own value in the structure.
- Return values
-
0 (success) -errno (failure)
- See also
- m0_net_tm_init()
◆ xo_tm_start
| int(* xo_tm_start) (struct m0_net_transfer_mc *tm, const char *addr) |
Initiates the startup of the (initialized) transfer machine. A completion event should be posted when started, using a different thread. Serialized using the transfer machine mutex.
The following fields are of special interest to this method:
- ntm_dom
- ntm_xprt_private
- Parameters
-
addr Address (network end-point string representation) of the transfer machine. The method should not reference this string after it returns.
- See also
- m0_net_tm_start()
◆ xo_tm_stop
| int(* xo_tm_stop) (struct m0_net_transfer_mc *tm, bool cancel) |
Initiates the shutdown of a transfer machine, cancelling any pending startup. No incoming messages should be accepted. Pending operations should drain or be cancelled if requested. A completion event should be posted when stopped, using a different thread. Serialized using the transfer machine mutex.
- Parameters
-
tm Transfer machine pointer. cancel Pending outbound operations should be cancelled immediately.
- Return values
-
0 (success) -errno (failure)
- See also
- m0_net_tm_stop()
The documentation for this struct was generated from the following file:
- net/net.h
