Manpage of T_GETPROTADDR

T_GETPROTADDR

Section: OpenSS7 XTI/TLI Networking Library Calls (3)
Updated: 2008-10-31
Index Return to Main Contents

NAME

t_getprotaddr - get protocol addresses

SYNOPSIS

#include <xti.h>

int t_getprotaddr(int fd, struct t_bind *loc, struct t_bind *rem);

ARGUMENTS

fd: the transport endpoint for which to retreive protocol addresses.
loc: a pointer to a t_bind structure to contain the returned local address.
rem: a pointer to a t_bind structure to contain the returned remote address.

DESCRIPTION

fd specifies the local transport endpoint for which to retrieve address information.

loc is a pointer to a t_bind structure that returns the local endpoint transport address bound to fd, if fd is in a bound state.

rem is a pointer to a t_bind structure that returns the remote endpoint transport address connected to fd, if fd is in a connected state.

The t_bind structure is formatted as follows:

struct t_bind {
        struct netbuf addr;
        unsigned int qlen;
};

The t_bind structure contains the following members:

addr

is a netbuf(3) structure that specifies the local or remote address.

loc->addr.maxlen is significant on call and loc->addr.len is significant on return. If loc->addr.maxlen is zero on call, then the local address will not be returned. When a local address is returned, loc->addr.len will be non-zero on successful return.

rem->addr.maxlen is significant on call and loc->addr.len is significant on return. If rem->addr.maxlen is zero on call, then the remote address will not be returned. When a remote address is returned, rem->addr.len will be non-zero on successful return.

qlen

this member is not used by t_getprotaddr() in either loc or rem structures and remains unchanged from call to return.

CAVEATS

t_getprotaddr() is valid in any state other than T_UNINT.

RETURN VALUE

Upon success, t_getproaddr() returns zero (0). Upon failure, t_getproaddr() returns -1 and sets t_errno(3) to an appropriate error number.

ERRORS

When t_getproaddr() fails, it returns -1 and sets t_errno(3) to an appropriate error number as follows:

[TBADF]: fd is invalid.
[TBUFOVFLW]: The loc->addr.maxlen or rem->addr.maxlen field of a netbuf(3) structure passed to the call was non-zero, but insufficient to hold the available local or remote address. See, netbuf(3) for more information.
[TPROTO]: A protocol error occured between the XTI/TLI library and the underlying transport provider.
[TSYSERR]: A Linux system error occured and the Linux error number is set in errno(3).

BUGS

t_getprotaddr() has no known bugs. t_getprotaddr() has been tested for the described behavior using the test-xnet(8) and test-xnet_thr(8) conformance test suites.

COMPATIBILITY

The XTI/TLI library functions are compatible with SVR4.2[1], XNS 5.2[2], SUSv2[3]. Compatibility is tested using the test-xnet(8) and test-xnet_thr(8) test case executables and the OpenSS7 XTI/TLI Networking autotest test suite.

CONFORMANCE

XTI/TLI[4], TPI[5], XPG5, XNS 5.2[2], SUSv2[3]. Conformance is tested using the test-xnet(8) and test-xnet_thr(8) test case executables and the OpenSS7 XTI/TLI Networking autotest test suite.

HISTORY

t_getprotaddr first appeared in SVR4.2[1].

VERSIONS

This manpage was written for the OpenSS7 XTI/TLI Library.

REFERENCES

[1]: SVR 4.2, UNIX® System V Release 4.2 Programmer's Manual, 1992, (Englewood Cliffs, New Jersey), AT&T UNIX System Laboratories, Inc., Prentice Hall.
[2]: XNS, Open Group CAE Specification: Technical Standard: Network Services (XNS), Issue 5.2, Draft 2, 1999, (Berkshire, UK), OpenGroup, Open Group Publication. [ISBN 1-85912-241-8] <http://www.opengroup.org/onlinepubs/>
[3]: SUS Version 2, Single UNIX Specification, OpenGroup, Open Group Publication. <http://www.opengroup.org/onlinepubs/>
[4]: XTI/TLI Revision 1.0, Open Group CAE Specification: XOpen Transport Interface, Revision 1, n.d., (Berkshire, UK), XPG, X Programmer's Group. <http://www.opengroup.org/onlinepubs/>
[5]: TPI Revision 2.0.0, Open Group CAE Specification: Transport Provider Interface (TPI) Specification, Revision 2.0.0, Draft 2, 1999, (Berkshire, UK), OpenGroup, Open Group Publication. <http://www.opengroup.org/onlinepubs/>

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 XTI/TLI Networking: Package strxnet version 0.9.2.12 released 2008-10-31.

Index

NAME
SYNOPSIS
ARGUMENTS
DESCRIPTION
CAVEATS
RETURN VALUE
ERRORS
SEE ALSO
BUGS
COMPATIBILITY
CONFORMANCE
HISTORY
VERSIONS
REFERENCES
TRADEMARKS
IDENTIFICATION

This document was created by man2html, using the manual pages.
Time: 22:05:17 GMT, May 20, 2013