RSM_MEMSEG_IMPORT_SET_MODE(3RSM) Remote Shared Memory Library Functions

NAME

rsm_memseg_import_set_mode, rsm_memseg_import_get_mode - set or get
mode for barrier scoping

SYNOPSIS

cc [ flag... ] file... -lrsm [ library... ]
#include <rsmapi.h>

int rsm_memseg_import_set_mode(rsm_memseg_import_handle_t memseg,
rsm_barrier_mode_t mode);


int rsm_memseg_import_get_mode(rsm_memseg_import_handle_t memseg,
rsm_barrier_mode_t *mode);

DESCRIPTION

The rsm_memseg_import_set_mode() function provides support for
optional explicit barrier scoping in the functions described on the
rsm_memseg_import_get(3RSM) and rsm_memseg_import_put(3RSM) manual
pages. The two valid barrier modes are RSM_BARRIER_MODE_EXPLICIT and
RSM_BARRIER_MODE_IMPLICIT. By default, the barrier mode is set to
RSM_BARRIER_MODE_IMPLICIT. When the mode is
RSM_BARRIER_MODE_IMPLICIT, an implicit barrier open and barrier close
is applied to the put operation. Irrespective of the mode set, the
barrier must be initialized using the
rsm_memseg_import_init_barrier(3RSM) function before any barrier
operations, either implicit or explicit, are used.


The rsm_memseg_import_get_mode() function obtains the current value
of the mode used for barrier scoping in put functions.

RETURN VALUES

Upon successful completion, these functions return 0. Otherwise, an
error value is returned to indicate the error.

ERRORS

The rsm_memseg_import_set_mode() and rsm_memseg_import_get_mode()
functions can return the following errors:

RSMERR_BAD_SEG_HNDL
Invalid segment handle.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO

rsm_memseg_import_get(3RSM), rsm_memseg_import_init_barrier(3RSM),
rsm_memseg_import_put(3RSM), attributes(7)

August 29, 2021
RSM_MEMSEG_IMPORT_SET_MODE(3RSM)