1rsm_get_controller(3RRSeMm)ote Shared Memory Library Functirosnms_get_controller(3RSM)
2
3
4

NAME

6       rsm_get_controller,  rsm_get_controller_attr,  rsm_release_controller -
7       get or release a controller handle
8

SYNOPSIS

10       cc [ flag... ] file... -lrsm [ library... ]
11       #include <rsmapi.h>
12
13       int rsm_get_controller(char *name,
14            rsmapi_controller_handle_t *controller);
15
16
17       int rsm_get_controller_attr(rsmapi_controller_handle_t chdl,
18            rsmapi_controller_attr_t *attr);
19
20
21       int rsm_release_controller(rsmapi_controller_handle_t chdl);
22
23

DESCRIPTION

25       The controller functions provide mechanisms for obtaining access  to  a
26       controller,  determining  the  characteristics  of  the controller, and
27       releasing the controller.
28
29
30       The  rsm_get_controller() function acquires a controller handle through
31       the  controller argument.  The name argument is the specific controller
32       instance (for example, "sci0" or "loopback"). This controller handle is
33       used for subsequent RSMAPI calls.
34
35
36       The   rsm_get_controller_attr()   function   obtains   a   controller's
37       attributes through the attr argument. The chdl  argument  is  the  con‐
38       troller   handle  obtained  by  the    rsm_get_controller()  call.  The
39       attribute structure is defined in the <rsmapi> header.
40
41
42       The  rsm_release_controller() function releases the  resources  associ‐
43       ated  with  the  controller  identified  by the controller handle chdl,
44       obtained  by  calling   rsm_get_controller().   Each   rsm_release_con‐
45       troller()  call must have a corresponding rsm_get_controller() call. It
46       is illegal to access a controller  or  segments  exported  or  imported
47       using a released controller.
48

RETURN VALUES

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

ERRORS

54       The      rsm_get_controller(),      rsm_get_controller_attr(),      and
55       rsm_release_controller() functions can return the following errors:
56
57       RSMERR_BAD_CTLR_HNDL     Invalid controller handle.
58
59
60
61       The  rsm_get_controller()  and  rsm_get_controller_attr() functions can
62       return the following errors:
63
64       RSMERR_BAD_ADDR     Bad address.
65
66
67
68       The  rsm_get_controller() function can return the following errors:
69
70       RSMERR_CTLR_NOT_PRESENT
71
72           Controller not present.
73
74
75       RSMERR_INSUFFICIENT_MEM
76
77           Insufficient memory.
78
79
80       RSMERR_BAD_LIBRARY_VERSION
81
82           Invalid library version.
83
84

ATTRIBUTES

86       See attributes(5) for descriptions of the following attributes:
87
88
89
90
91       ┌─────────────────────────────┬─────────────────────────────┐
92       │ATTRIBUTE TYPE               │ATTRIBUTE VALUE              │
93       ├─────────────────────────────┼─────────────────────────────┤
94       │Interface Stability          │Evolving                     │
95       ├─────────────────────────────┼─────────────────────────────┤
96       │MT-Level                     │MT-Safe                      │
97       └─────────────────────────────┴─────────────────────────────┘
98

SEE ALSO

100       rsm_memseg_export_create(3RSM),        rsm_memseg_import_connect(3RSM),
101       attributes(5)
102
103
104
105SunOS 5.11                        8 Jun 2001          rsm_get_controller(3RSM)
Impressum