Manpage of DLPIAPI

Description: Manual Page

Keywords: ss7 ss7/ip ss7 over ip ss7 mtp ss7 sccp ss7 tcap sigtran mtp sccp tcap openss7 acb56 linux telephony pstn linux telephony linux nebs linux compactpci

---

DLPIAPI

Section: OpenSS7 DLPI API Library (3)
Updated: 2008-10-31
Index Return to Main Contents

---

NAME

DLPIAPI, dlpiapi, libdlpiapi - DLPI API Library

INTERFACE

DLPI[1] Application Program Interface[2].
GCOM, Inc., specific and proprietary.

LIBRARY

libdlpiapi(3), the DLPI API Library.

SYNOPSIS

#include <sys/types.h>
#include <sys/ioctl.h>
#include <sys/stropts.h>
#define _SUN_SOURCE
#define _HPUX_SOURCE
#define _AIX_SOURCE
#include <sys/dlpi.h>
#include <dlpiapi.h>

int dlpi_attach_ppa(intfd, ulongppa);

int dlpi_bind_dlsap(intfd, ulongdlsap, intconind_nr);

int dlpi_clear_zombies(void);

int dlpi_close(intfd);

int dlpi_complete_req(intfd, intrequest, char *caller, intdiscard_un_iframes);

int dlpi_configure_dlsaps(intfd, ulonglocal_dlsap, ulongremote_dlsap);

int dlpi_connect(ulongppa, ulongbind_dlsap, ulonglocal_dlsap, ulongremote_dlsap);

int dlpi_connect_req(intfd, ulongpeer_sap);

int dlpi_connect_wait(intdata);

void dlpi_decode_ctl(char *p);

char *dlpi_decode_disconnect_reason(longreason);

int dlpi_discon_req(intfd, intreason);

int dlpi_disconnect_req(intfd, intreason);

int dlpi_get_a_msg(intfd, char *buf, intcnt);

int dlpi_get_info(char *ptr);

int dlpi_get_style(void);

int dlpi_init(uintlog_optns, char *log_name);

int dlpi_init_FILE(uintlog_optns, FILE *log_file);

int dlpi_listen(ulongppa, ulongbind_dlsap, ulonglocal_dlsap, ulongremote_dlsap, uintfork_options);

int dlpi_open(char *hostname);

int dlpi_open_data(void);

int dlpi_open_log(void);

int dlpi_perror(char *prefix);

int dlpi_print_msg(char *msg, uintlength, intindent);

int dlpi_printf(char *fmt, ...);

int dlpi_put_both(intfd, char *hdr_ptr, inthdr_lgth, char *data_ptr, intdata_lgth);

int dlpi_put_proto(intfd, intlgth);

int dlpi_rcv(intfd, char *data_ptr, intbfr_len, intflags, long *out_code);

int dlpi_rcv_msg(intfd, char *data_ptr, intdata_cnt, intflags);

int dlpi_read_data(intfd, char *buf, intcnt);

int dlpi_reset_req(intfd);

int dlpi_reset_res(intfd);

int dlpi_send_attach_req(intfd, ulongppa);

int dlpi_send_bind_req(intfd, ulongdlsap, intconind_nr, intservice_mode, intconn_mgnt, intauto_flags);

int dlpi_send_connect_req(intfd, ulongpeer_sap);

int dlpi_send_connect_res(intfd, ulongcorrelation, ulongdlpi_token);

int dlpi_send_detach_req(intfd);

int dlpi_send_disconnect_req(intfd, intreason);

int dlpi_send_info_req(intfd);

int dlpi_send_reset_req(intfd);

int dlpi_send_reset_res(intfd);

int dlpi_send_stats_req(intfd);

int dlpi_send_test_req(intfd, ulongpfb, char *datap, intlength, unsigned char *addr_ptr, intaddr_len);

int dlpi_send_test_res(intfd, ulongpfb, char *datap, intlength, unsigned char *addr_ptr, intaddr_len);

int dlpi_send_uic(intfd, char *datap, intdata_len, unsigned char *addr_ptr, intaddr_len);

int dlpi_send_unbind_req(intfd);

int dlpi_send_xid_req(intfd, ulongpfb, char *datap, intlength, unsigned char *addr_ptr, intaddr_len);

int dlpi_send_xid_res(intfd, ulongpfb, char *datap, intlength, unsigned char *addr_ptr, intaddr_len);

int dlpi_set_log_size(longlog_size);

int dlpi_set_signal_handling(intfd, dlpi_sig_func_tfunc, intsig_num, intprimitive_mask);

int dlpi_set_unnum_frame_handler(intfd, unnum_frame_thandler);

int dlpi_test_req(intfd, ulongpfb, char *datap, intlength);

int dlpi_test_res(intfd, ulongpfb, char *datap, intlength);

int dlpi_uic_req(intfd, char *datap, intlength);

int dlpi_unbind_dlsap(intfd);

int dlpi_test_res(intfd, ulongpfb, char *datap, intlength);

int dlpi_xid_res(intfd, ulongpfb, char *datap, intlength);

int dlpi_write_data(intfd, char *buf, intcnt);

int dlpi_xray_req(intfd, intupa, inton_off, inthi_wat, intlo_wat);

OVERVIEW

libdlpiapi
is an OpenSS7 implementation of the GCOM DLPI API Library[2] for Linux Fast-STREAMS.

DESCRIPTION

The DLPI API Library is a library of DLPI helper and utility functions designed for use with the Data Link Provider Interface (DLPI)[1], dlpi(7). The original library was designed by GCOM, Inc., <http://www.gcom.com/>, and first documented[2] in 1995.

The DLPI API Library documented here is the OpenSS7 implementation of a library intended on being a work-alike with the GCOM library in accordance with the GCOM documentation[2].

The GCOM-compatible DLPI API Library should not be confused with the Solaris®-compatible DLPI Library, libdlpi(3). The two libraries are incompatible and have namespace conflicts (primarily on dlpi_open(3) and dlpi_close(3)).

FUNCTIONS

libdlpiapi implements the following DLPI API library functions:

dlpi_attach_ppa(3)	-	attach a PPA.
dlpi_bind_dlsap(3)	-	bind a DLSAP.
dlpi_clear_zombies(3)	-	clear zombies.
dlpi_close(3)	-	close.
dlpi_complete_req(3)	-	complete a prior request.
dlpi_configure_dlsaps(3)	-	configure DLSAPs.
dlpi_connect(3)	-	create and connect.
dlpi_connect_req(3)	-	connect.
dlpi_connect_wait(3)	-	listen.
dlpi_decode_ctl(3)	-	decode a control message.
dlpi_decode_disconnect_reason(3)	-	decode disconnect reason.
dlpi_detach_ppa(3)	-	detach a PPA.
dlpi_discon_req(3)	-	disconnect.
dlpi_get_a_msg(3)	-	get a message.
dlpi_get_both(3)	-	get control and data.
dlpi_get_info_strm(3)	-	get information.
dlpi_get_style_strm(3)	-	get provider style.
dlpi_init(3)	-	initialize the library.
dlpi_listen(3)	-	listen.
dlpi_open(3)	-	open.
dlpi_open_log(3)	-	open a log file.
dlpi_perror(3)	-	print an error string.
dlpi_print_msg(3)	-	print a message.
dlpi_printf(3)	-	print a string.
dlpi_put_both(3)	-	put control and data.
dlpi_put_proto(3)	-	put control message.
dlpi_rcv(3)	-	receive data.
dlpi_rcv_msg(3)	-	receive data message.
dlpi_read_data(3)	-	read data.
dlpi_reset_req(3)	-	reset.
dlpi_reset_res(3)	-	accept reset.
dlpi_send_attach_req(3)	-	send DL_ATTACH_REQ(7).
dlpi_send_bind_req(3)	-	send DL_BIND_REQ(7).
dlpi_send_connect_req(3)	-	send DL_CONNECT_REQ(7).
dlpi_send_connect_res(3)	-	send DL_CONNECT_RES(7).
dlpi_send_detach_req(3)	-	send DL_DETACH_REQ(7).
dlpi_send_disconnect_req(3)	-	send DL_DISCONNECT_REQ(7).
dlpi_send_info_req(3)	-	send DL_INFO_REQ(7).
dlpi_send_reset_req(3)	-	send DL_RESET_REQ(7).
dlpi_send_reset_res(3)	-	send DL_RESET_RES(7).
dlpi_send_stats_req(3)	-	send DL_GET_STATISTICS_REQ(7).
dlpi_send_test_req(3)	-	send DL_TEST_REQ(7).
dlpi_send_test_res(3)	-	send DL_TEST_RES(7).
dlpi_send_uic(3)	-	send DL_DATA_REQ(7).
dlpi_send_unbind_req(3)	-	send DL_UNBIND_REQ(7).
dlpi_send_xid_req(3)	-	send DL_XID_REQ(7).
dlpi_send_xid_res(3)	-	send DL_XID_RES(7).
dlpi_set_log_size(3)	-	set the log file size.
dlpi_set_signal_handling(3)	-	set signal handling.
dlpi_set_unnum_frame_handler(3)	-	set U-frame handler.
dlpi_set_test_req(3)	-	set TEST request.
dlpi_set_test_res(3)	-	set TEST response.
dlpi_uic_req(3)	-	issue U-frame.
dlpi_unbind_dlsap(3)	-	unbind from a DLSAP.
dlpi_xid_req(3)	-	request XID.
dlpi_xid_res(3)	-	response to XID.
dlpi_write_data(3)	-	write data.
dlpi_xray_req(3)	-	create an xray Stream.

USAGE

To use the DLPI API Library, include <sys/dlpi.h> and <dlpiapi.h> header files in C language programs. Add the `-ldlpiapi' flag to the linker command when linking C language programs that use this library, or add /usr/lib/libdlpiapi.a to the objects linked.

MT CONTEXT

The OpenSS7 XNS Networking implementation of the DLPI API Library is fully thread-safe. The variables documented as global are instead contained in thread-specific data. When static buffers are returned, these buffers are instead thread-specific.

RETURN

Most function call return zero (0) on success and minus one (-1) on error.

ERRORS

When most functions fail, they return minus one (-1) and set the global errno(3) variable to an appropriate error code.

NOTICES

The DLPI API Library is GCOM-specific[2]. It may be necessary to define the `C' preprocessor symbol, _GCOM_SOURCE, before including the <sys/dlpi.h> header file to expose the symbolic constants, data structures and declarations necessary for the use of these functions. It may be necessary to include the <dlpiapi.h> header file to expose the symbolic constants, data structures and declarations necessary for the user of these functions.

FILES

/usr/include/strxns/sys/dlpi.h

the standard DLPI[1] header file.

/usr/include/strxns/dlpiapi.h

the GCOM-specific header file.

/usr/lib/libdlpiapi.a

the static library version of the DLPI API Library.

/usr/lib/libdlpiapi.so

the shared object library version of the DLPI API Library.

BUGS

The DLPI API Library has no known bugs.

SEE ALSO

dlpi(7), cdiapi(3), dlpiapi(3), npiapi(3), STREAMS(9).

COMPATIBILITY

The OpenSS7 DLPI API library is compatible with documentation of the GCOM DLPI API library[2] and applications based on the DLPI API, with the following compatibility considerations:

---

Application programming interfaces for devices and modules that implement the Data Link Provider Interface (DLPI)[1], dlpi(7), have not been subjected to standardization and are, therefore, inherently non-portable. Portable STREAMS applications, drivers and modules will utilize the service primitive interface directly using putmsg(2s), getmsg(2s), write(2s), read(2s) and ioctl(2s) system calls and the definitions provided in the <sys/dlpi.h> header file.

---

DLPI API Library functions are GCOM-specific[2], and are provided only for porting GCOM applications, drivers and modules to Linux Fast-STREAMS. They are inherently non-portable. These functions will be avoided by portable DLPI application programs, drivers and modules.

---

Binary compatibility is not attempted, only source compatibility: any binary compatibility experienced is coincidental and may change on a future release.

It may be necessary to recompile all applications programs, and STREAMS drivers and modules, that share definitions with the DLPI API library through the <dlpiapi.h> header file, using OpenSS7 XNS Networking supplied header files.

---

The OpenSS7 XNS Networking implementation of the DLPI API Library is designed to be fully thread-safe. When used in a POSIX threads environment, the implementation is not expected to be bug-for-bug compatible with the GCOM implementation, which does not document interactions with multi-threaded programs.

For further compatibility information, see dlpi(7) and STREAMS(9).

CONFORMANCE

DLPI[1], DLPI API documentation[2].

HISTORY

DLPI first appeared in SVR 4[3].

DLPI API documentation[2] was first issued by GCOM in 1995.

VERSIONS

This manual page was written for the OpenSS7 XNS Networking version of the DLPI API Library.

REFERENCES

[1]

DLPI, Data Link Provider Interface (DLPI) Specification, Revision 2.0.0, Draft 2, August 20, 1991, (Parsippany, New Jersey), UNIX. International,Inc., UNIX International Press. <http://www.openss7.org/doc/dlpi.pdf>

[2]

DLPI-API, DLPI --- Application Program Inteface Guide, Original Edition, 1995, April 2003, (Savoy, IL), D. J. Schweiger, D. Healy and D. Grothe, GCOM. <http://www.gcom.com/>

[3]

SVR 4, UNIX® System V Release 4 Programmer's Manual, 1990, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.

TRADEMARKS

OpenSS7tm

is a trademark of OpenSS7 Corporation.

Linux®

is a registered trademark of Linus Torvalds.

UNIX®

is a registered trademark of The Open Group.

Solaris®

is a registered trademark of Sun Microsystems.

Other trademarks are the property of their respective owners.

IDENTIFICATION

OpenSS7 XNS Networking: Package strxns version 0.9.2.7 released 2008-10-31.

Copyright©1997-2008OpenSS7 Corp. All Rights Reserved.
(See roff source for permission notice.)

---

Index

NAME

INTERFACE

LIBRARY

SYNOPSIS

OVERVIEW

DESCRIPTION

FUNCTIONS

USAGE

MT CONTEXT

RETURN

ERRORS

NOTICES

FILES

BUGS

SEE ALSO

COMPATIBILITY

CONFORMANCE

HISTORY

VERSIONS

REFERENCES

TRADEMARKS

IDENTIFICATION

---

This document was created by man2html, using the manual pages.
Time: 23:51:59 GMT, May 22, 2013