uct_tag_context Struct Reference

Posted tag context. More...

Data Fields
void(*	tag_consumed_cb )(uct_tag_context_t *self)
void(*	completed_cb )(uct_tag_context_t *self, uct_tag_t stag, uint64_t imm, size_t length, void *inline_data, ucs_status_t status)
void(*	rndv_cb )(uct_tag_context_t *self, uct_tag_t stag, const void *header, unsigned header_length, ucs_status_t status, unsigned flags)
char	priv [UCT_TAG_PRIV_LEN]

Detailed Description

Tag context is an object which tracks a tag posted to the transport. It contains callbacks for matching events on this tag.

Field Documentation

tag_consumed_cb

void(* uct_tag_context::tag_consumed_cb) (uct_tag_context_t *self)

Tag is consumed by the transport and should not be matched in software.

Parameters

[in]

self

Pointer to relevant context structure, which was initially passed to uct_iface_tag_recv_zcopy.

completed_cb

void(* uct_tag_context::completed_cb) (uct_tag_context_t *self, uct_tag_t stag, uint64_t imm, size_t length, void *inline_data, ucs_status_t status)

Tag processing is completed by the transport.

Parameters

[in]	self	Pointer to relevant context structure, which was initially passed to uct_iface_tag_recv_zcopy.
[in]	stag	Tag from sender.
[in]	imm	Immediate data from sender. For rendezvous, it's always 0.
[in]	length	Completed length.
[in]	inline_data	If non-null, points to a temporary buffer which contains the received data. In this case the received data was not placed directly in the receive buffer. This callback routine is responsible for copy-out the inline data, otherwise it is released.
[in]	status	Completion status: (a) UCS_OK - Success, data placed in provided buffer. (b) UCS_ERR_TRUNCATED - Sender's length exceed posted buffer, no data is copied. (c) UCS_ERR_CANCELED - Canceled by user.

rndv_cb

void(* uct_tag_context::rndv_cb) (uct_tag_context_t *self, uct_tag_t stag, const void *header, unsigned header_length, ucs_status_t status, unsigned flags)

Tag was matched by a rendezvous request, which should be completed by the protocol layer.

Parameters

[in]	self	Pointer to relevant context structure, which was initially passed to uct_iface_tag_recv_zcopy.
[in]	stag	Tag from sender.
[in]	header	User defined header.
[in]	header_length	User defined header length in bytes.
[in]	status	Completion status.
[in]	flags	Flags defined by UCT_TAG_RECV_CB_xx.

priv

char uct_tag_context::priv[UCT_TAG_PRIV_LEN]

A placeholder for the private data used by the transport

---

The documentation for this struct was generated from the following file:

• uct.h