CDI_READ_DATA

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

NAME

cdi_read_data - read data from CDI stream.

INTERFACE

libdlpiapi(3), the GCOM-specific, CDI[1] API Library[2].

SYNOPSIS

#include <sys/cdi.h>
#include <cdiapi.h>

intcdi_read_data(intfd, char*buf, intnbytes);

ARGUMENTS

fd: the file descriptor for the Stream.
buf: a buffer into which to read the data portion of the message.
nbytes: the number of bytes in the buffer.

DESCRIPTION

cdi_read_data is a CDI API Library[2] subroutine.

USAGE

To use the cdi_read_data function, include <sys/cdi.h> and <cdiapi.h> header files in C language programs. Add the `-lcdiapi' flag to the linker command when linking C language programs that use the cdi_read_data function.

MT CONTEXT

cdi_read_data is fully thread-safe. What is described as global variables are in fact thread-specific data when linked with libpthread.

RETURN

When cdi_read_data is successful, it returns zero (0) or a positive integer value. When cdi_read_data fails, it returns a negative integer value (-1).

ERRORS

When cdi_read_data fails, it returns a negative integer value (-1). cdi_read_data may fail when:

[EBADF]: the file descriptor, fd, supplied does not correspond to a valid CDI Stream open for reading and writing.
[EINVAL]: one or more of the arguments are invalid.

In addition, any of the error number returned by cdi_get_a_msg(3) can be returned by cdi_read_data.

NOTICES

cdi_read_data is a GCOM-specific function. It may be necessary to define the C preprocessor symbol, _GCOM_SOURCE, before including the <sys/cdi.h> header file, to expose this symbolic constants, data structures and declarations necessary for the use of this function. It may also be necessary to include the <cdiapi.h> header file to expose this symbolic constants, data structures and declarations necessary for the use of this function.

FILES

/usr/include/strxns/sys/cdi.h: The CDI header file.
/usr/include/strxns/cdiapi.h: The CDI API Library header file.
/usr/lib/libcdiapi.a: The static library containing the cdi_read_data function.
/usr/lib/libcdiapi.so: The shared object library containing the cdi_read_data function.

BUGS

cdi_read_data has no known bugs.

COMPATIBILITY

cdi_read_data is compatible with the GCOM CDI API Library[3], and system providing an interface equivalent to the GCOM CDI API Library, with the following portability considerations:

---: CDI API Library functions are GCOM-specific, and are provided only for porting GCOM software to Linux. They are inherently non-portable. These functions will be avoided by portable CDI programs.
---: 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 STREAMS drivers and modules that share definitions with the CDI API library using OpenSS7 XNS Networking supplied header files.

For further compatibility information, see cdiapi(3), cdi(7), STREAMS(9).

CONFORMANCE

CDI[1], and GCOM CDI API documentation[2].

HISTORY

The Communications Device Interface (CDI)[1], cdi(7), was developed by NCR Comten. cdi_read_data first appeared in the GCOM CDI API[2].

VERSIONS

This manual page was written for the OpenSS7 XNS Networking implementation of the CDI API Library.

REFERENCES

[1]: CDI, OpenSS7 CAE Specification: Communications Device Interface (CDI) Specification, Revision 0.9.2, Draft 2, July 15, 2007, (Edmonton, Canada), B. Bidulock, OpenSS7 Corporation. Distributed with package strxns-0.9.2. <http://www.openss7.org/specs/cdi.pdf>
[2]: CDI-API, CDI --- Application Program Interface Guide, Original Edition, 1997, March 1999, (Savoy, IL), G. Gerrietts, D. Grothe, M. Matthews and D. Healy, GCOM. <http://www.gcom.com/>
[3]: NPI-API, NPI --- Application Program Interface Guide, Original Edition, 1995, April 1998, (Savoy, IL), S. D. Smith, D. Grothe, D. Healy and C. Lipp, GCOM. <http://www.gcom.com/>

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.

Index

NAME
INTERFACE
SYNOPSIS
ARGUMENTS
DESCRIPTION
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: 04:16:05 GMT, May 24, 2013

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