LCI property list

A property list is a collection of properties used to create an endpoint. More...

Collaboration diagram for LCI property list:

Typedefs
typedef struct LCI_plist_s *	LCI_plist_t
	The property list type. More...

Functions
LCI_API LCI_error_t	LCI_plist_create (LCI_plist_t *plist_ptr)
	Create a property list. More...
LCI_API LCI_error_t	LCI_plist_free (LCI_plist_t *plist_ptr)
	Free a property list. More...
LCI_API LCI_error_t	LCI_plist_get (LCI_endpoint_t ep, LCI_plist_t *plist_ptr)
	Query the property list of an endpoint. More...
LCI_API LCI_error_t	LCI_plist_decode (LCI_plist_t plist, char *string)
	Decode a property list into a string. More...
LCI_API LCI_error_t	LCI_plist_set_match_type (LCI_plist_t plist, LCI_match_t match_type)
	Set the tag matching rule of the property list. More...
LCI_API LCI_error_t	LCI_plist_set_comp_type (LCI_plist_t plist, LCI_port_t port, LCI_comp_type_t comp_type)
	Set the completion mechanism of the property list. More...
LCI_API LCI_error_t	LCI_plist_set_default_comp (LCI_plist_t plist, LCI_comp_t comp)
	Set the default completion mechanism of the property list. The default completion mechanism will be triggered by a remote one-sided communication operation through LCI_DEFAULT_COMP_REMOTE. More...

Detailed Description

A property list is a collection of properties used to create an endpoint.

Typedef Documentation

LCI_plist_t

typedef struct LCI_plist_s* LCI_plist_t

The property list type.

Function Documentation

LCI_plist_create()

LCI_API LCI_error_t LCI_plist_create

(

LCI_plist_t *

plist_ptr

)

Create a property list.

Parameters

[out]

plist_ptr

Pointer to a property list to create.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.

LCI_plist_decode()

LCI_API LCI_error_t LCI_plist_decode	(	LCI_plist_t	plist,
		char *	string
	)

Decode a property list into a string.

Parameters

[in]	plist	The property list to decode.
[out]	string	Pointer to an array of chars to write the decode result.

Returns

No available yet. Should always be LCI_ERR_FEATURE_NA.

LCI_plist_free()

LCI_API LCI_error_t LCI_plist_free

(

LCI_plist_t *

plist_ptr

)

Free a property list.

Parameters

[in,out]

plist_ptr

Pointer to a property list to free.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.

LCI_plist_get()

LCI_API LCI_error_t LCI_plist_get	(	LCI_endpoint_t	ep,
		LCI_plist_t *	plist_ptr
	)

Query the property list of an endpoint.

Parameters

[in]	ep	The endpoint to query.
[out]	plist	Pointer to the property list to write the query result.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.

LCI_plist_set_comp_type()

LCI_API LCI_error_t LCI_plist_set_comp_type	(	LCI_plist_t	plist,
		LCI_port_t	port,
		LCI_comp_type_t	comp_type
	)

Set the completion mechanism of the property list.

Parameters

[in]	plist	The property list to set.
[in]	port	Whether to set the completion mechanism for send or receive.
[in]	match_type	The matching type to set.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.

LCI_plist_set_default_comp()

LCI_API LCI_error_t LCI_plist_set_default_comp	(	LCI_plist_t	plist,
		LCI_comp_t	comp
	)

Set the default completion mechanism of the property list. The default completion mechanism will be triggered by a remote one-sided communication operation through LCI_DEFAULT_COMP_REMOTE.

Parameters

[in]	plist	The property list to set.
[in]	comp	The default completion mechanism to set.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.

LCI_plist_set_match_type()

LCI_API LCI_error_t LCI_plist_set_match_type	(	LCI_plist_t	plist,
		LCI_match_t	match_type
	)

Set the tag matching rule of the property list.

Parameters

[in]	plist	The property list to set.
[in]	match_type	The matching type to set.

Returns

Should always be LCI_OK. All the other errors are fatal as defined by LCI_error_t.