xti.h

OpenSS7 This the fourth public release of the OpenSS7 Master Package. See README in the release for

/*****************************************************************************

 @(#) xti.h,v 0.9.2.4 2006/09/25 12:10:08 brian Exp

 -----------------------------------------------------------------------------

 Copyright (c) 2001-2006  OpenSS7 Corporation <http://www.openss7.com/>
 Copyright (c) 1997-2001  Brian F. G. Bidulock <[e-mail]>

 All Rights Reserved.

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free Software
 Foundation; version 2 of the License.

 This program is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 details.

 You should have received a copy of the GNU General Public License along with
 this program; if not, write to the Free Software Foundation, Inc., 675 Mass
 Ave, Cambridge, MA 02139, USA.

 -----------------------------------------------------------------------------

 U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software on
 behalf of the U.S. Government ("Government"), the following provisions apply
 to you.  If the Software is supplied by the Department of Defense ("DoD"), it
 is classified as "Commercial Computer Software" under paragraph 252.227-7014
 of the DoD Supplement to the Federal Acquisition Regulations ("DFARS") (or any
 successor regulations) and the Government is acquiring only the license rights
 granted herein (the license rights customarily provided to non-Government
 users).  If the Software is supplied to any unit or agency of the Government
 other than DoD, it is classified as "Restricted Computer Software" and the
 Government's rights in the Software are defined in paragraph 52.227-19 of the
 Federal Acquisition Regulations ("FAR") (or any successor regulations) or, in
 the cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the FAR
 (or any successor regulations).

 -----------------------------------------------------------------------------

 Commercial licensing and support of this software is available from OpenSS7
 Corporation at a fee.  See http://www.openss7.com/

 -----------------------------------------------------------------------------

 Last Modified 2006/09/25 12:10:08 by brian

 xti.h,v
 Revision 0.9.2.4  2006/09/25 12:10:08  brian
 - updated and doxygenified headers

 Revision 0.9.2.3  2005/05/14 08:30:43  brian
 - copyright header correction

 Revision 0.9.2.2  2004/09/02 09:31:14  brian
 - Synchronization with other packages.

 Revision 0.9.2.1  2004/05/12 08:01:38  brian
 - Added in xti library and STREAMS modules.

 Revision 1.1.4.2  2004/04/13 12:12:51  brian
 - Rearranged header files.

 *****************************************************************************/

#ifndef _XTI_H
#define _XTI_H

#ident "@(#) xti.h,v openss7-0_9_2_E(0.9.2.4) Copyright (c) 2001-2006 OpenSS7 Corporation."

/* This file can be processed with doxygen(1). */

/**
  * @weakgroup xnet OpenSS7 XNET Library
  * @{ */

/** @file
  * XTI (User) Header File. */

#include <sys/xti.h>
#include <sys/xti_inet.h>
#include <sys/xti_atm.h>
#include <sys/xti_osi.h>
#include <sys/xti_mosi.h>

#ifdef __BEGIN_DECLS
/* *INDENT-OFF* */
__BEGIN_DECLS
/* *INDENT-ON* */
#endif

#ifndef __KERNEL__
/**
  * @name XTI Library Functions
  * These are the formal version of the XTI library functions.  They are strong
  * aliased to the thread-safe "__xnet_t_*_r()" versions below.  Where a "_r"
  * version does not exist the "__xnet_t_*()" version below is used in its
  * stead.
  * @{ */
/* *INDENT-OFF* */
/** XTI Library Function: t_accept - accept a connection request. */
extern int t_accept(int, int, const struct t_call *);
/** XTI Library Function: t_addleaf - add a leaf to point to multipoint
  * connection. */
extern int t_addleaf(int, int, struct netbuf *);
/** XTI Library Function: t_alloc - allocate a library structure. */
extern char *t_alloc(int, int, int);
/** XTI Library Function: t_bind - bind an address to a transport endpoint. */
extern int t_bind(int, const struct t_bind *, struct t_bind *);
/** XTI Library Function: t_close - close a transport endpoint. */
extern int t_close(int);
/** XTI Library Function: t_connect - establish a connection. */
extern int t_connect(int, const struct t_call *, struct t_call *);
/** XTI Library Function: t_error - produce error message. */
extern int t_error(const char *);
/** XTI Library Function: t_free - free a library structure. */
extern int t_free(void *, int);
/** XTI Library Function: t_getinfo - get protocol-specific service information.  */
extern int t_getinfo(int, struct t_info *);
/** XTI Library Function: t_getprotaddr - get protocol addresses. */
extern int t_getprotaddr(int, struct t_bind *, struct t_bind *);
/** XTI Library Function: t_getstate - get the current state. */
extern int t_getstate(int);
/** XTI Library Function: t_listen - listen for a connection indication. */
extern int t_listen(int, struct t_call *);
/** XTI Library Function: t_look - look at current event on a transport
  * endpoint.  */
extern int t_look(int);
/** XTI Library Function: t_open - establish a transport endpoint. */
extern int t_open(const char *, int, struct t_info *);
/** XTI Library Function: t_optmgmt - manage options for a transport endpoint.  */
extern int t_optmgmt(int, const struct t_optmgmt *, struct t_optmgmt *);
/** XTI Library Function: t_rcv - receive data or expedited data on a
  * connection.  */
extern int t_rcv(int, char *, unsigned int, int *);
/** XTI Library Function: t_rcvconnect - receive the confirmation from a
  * connection request. */
extern int t_rcvconnect(int, struct t_call *);
/** XTI Library Function: t_rcvdis - retrieve information from disconnect. */
extern int t_rcvdis(int, struct t_discon *);
/** XTI Library Function: t_rcvleafchange - acknowledge receipt of a leaf change
  * indication. */
extern int t_rcvleafchange(int, struct t_leaf_status *);
/** XTI Library Function: t_rcvopt - receive data with options. */
extern int t_rcvopt(int fd, struct t_unitdata *optdata, int *flags);
/** XTI Library Function: t_rcvrel - acknowledge receipt of an orderly release
  * indication. */
extern int t_rcvrel(int);
/** XTI Library Function: t_rcvreldata - receive an orderly release indication
  * or confirmation containing user data. */
extern int t_rcvreldata(int, struct t_discon *);
/** XTI Library Function: t_rcvudata - receive a data unit. */
extern int t_rcvudata(int, struct t_unitdata *, int *);
/** XTI Library Function: t_rcvuderr - receive a unit data error indication. */
extern int t_rcvuderr(int, struct t_uderr *);
/** XTI Library Function: t_rcvv - receive data or expedited data sent over a
  * connection and put the data into one or more noncontiguous buffers. */
extern int t_rcvv(int, struct t_iovec *, unsigned int, int *);
/** XTI Library Function: t_rcvvopt - receive data with options into one or more
  * noncontiguous buffers. */
extern int t_rcvvopt(int fd, const struct t_unitdata *optdata, const
		     struct t_iovec *iov, unsigned int iovcount, int flags);