share/man/man3lib/librsm.3lib

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH LIBRSM 3LIB "May 22, 2003"
   7 .SH NAME
   8 librsm \- remote shared memory interface library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lrsm\fR [ \fIlibrary\fR... ]
  13 #include <rsmapi.h>
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The functions in this library provide an interface for OS bypass messaging for
  20 applications over high-speed interconnects, including facilities to set up
  21 low-latency, high-bandwidth interprocess communication mechanisms and to
  22 perform I/O.
  23 .SH INTERFACES
  24 .sp
  25 .LP
  26 The shared object \fBlibrsm.so.2\fR provides the public interfaces defined
  27 below. See \fBIntro\fR(3) for additional information on shared object
  28 interfaces.
  29 .sp
  30
  31 .sp
  32 .TS
  33 l l
  34 l l .
  35 \fBrsm_create_localmemory_handle\fR     \fBrsm_free_interconnect_topology\fR
  36 \fBrsm_free_localmemory_handle\fR       \fBrsm_get_controller\fR
  37 \fBrsm_get_controller_attr\fR   \fBrsm_get_interconnect_topology\fR
  38 \fBrsm_get_segmentid_range\fR   \fBrsm_intr_signal_post\fR
  39 \fBrsm_intr_signal_wait\fR      \fBrsm_intr_signal_wait_pollfd\fR
  40 \fBrsm_memseg_export_create\fR  \fBrsm_memseg_export_destroy\fR
  41 \fBrsm_memseg_export_publish\fR \fBrsm_memseg_export_rebind\fR
  42 \fBrsm_memseg_export_republish\fR       \fBrsm_memseg_export_unpublish\fR
  43 \fBrsm_memseg_get_pollfd\fR     \fBrsm_memseg_import_close_barrier\fR
  44 \fBrsm_memseg_import_connect\fR \fBrsm_memseg_import_destroy_barrier\fR
  45 \fBrsm_memseg_import_disconnect\fR      \fBrsm_memseg_import_get\fR
  46 \fBrsm_memseg_import_get16\fR   \fBrsm_memseg_import_get32\fR
  47 \fBrsm_memseg_import_get64\fR   \fBrsm_memseg_import_get8\fR
  48 \fBrsm_memseg_import_get_mode\fR        \fBrsm_memseg_import_getv\fR
  49 \fBrsm_memseg_import_init_barrier\fR    \fBrsm_memseg_import_map\fR
  50 \fBrsm_memseg_import_open_barrier\fR    \fBrsm_memseg_import_order_barrier\fR
  51 \fBrsm_memseg_import_put\fR     \fBrsm_memseg_import_put16\fR
  52 \fBrsm_memseg_import_put32\fR   \fBrsm_memseg_import_put64\fR
  53 \fBrsm_memseg_import_put8\fR    \fBrsm_memseg_import_putv\fR
  54 \fBrsm_memseg_import_set_mode\fR        \fBrsm_memseg_import_unmap\fR
  55 \fBrsm_memseg_release_pollfd\fR \fBrsm_release_controller\fR
  56 .TE
  57
  58 .SH FILES
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fB/usr/lib/librsm.so.2\fR \fR
  63 .ad
  64 .RS 28n
  65 shared object
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fB/usr/lib/64/librsm.so.2\fR \fR
  72 .ad
  73 .RS 28n
  74 64-bit shared object
  75 .RE
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     Evolving
  91 _
  92 MT-Level        Safe
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBIntro\fR(2), \fBIntro\fR(3), \fBattributes\fR(5)