Where Online Learning is simpler!

The C and C++ Include Header Files

/usr/include/tirpc/rpc/rpc_msg.h


$ cat -n /usr/include/tirpc/rpc/rpc_msg.h

     1	/*	$NetBSD: rpc_msg.h,v 1.11 2000/06/02 22:57:56 fvdl Exp $	*/
     2	
     3	/*
     4	 * Copyright (c) 2009, Sun Microsystems, Inc.
     5	 * All rights reserved.
     6	 *
     7	 * Redistribution and use in source and binary forms, with or without
     8	 * modification, are permitted provided that the following conditions are met:
     9	 * - Redistributions of source code must retain the above copyright notice,
    10	 *   this list of conditions and the following disclaimer.
    11	 * - Redistributions in binary form must reproduce the above copyright notice,
    12	 *   this list of conditions and the following disclaimer in the documentation
    13	 *   and/or other materials provided with the distribution.
    14	 * - Neither the name of Sun Microsystems, Inc. nor the names of its
    15	 *   contributors may be used to endorse or promote products derived
    16	 *   from this software without specific prior written permission.
    17	 *
    18	 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    19	 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    20	 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    21	 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    22	 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    23	 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    24	 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    25	 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    26	 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    27	 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    28	 * POSSIBILITY OF SUCH DAMAGE.
    29	 *
    30	 *	from: @(#)rpc_msg.h 1.7 86/07/16 SMI
    31	 *	from: @(#)rpc_msg.h	2.1 88/07/29 4.0 RPCSRC
    32	 * $FreeBSD: src/include/rpc/rpc_msg.h,v 1.15 2003/01/01 18:48:42 schweikh Exp $
    33	 */
    34	
    35	/*
    36	 * rpc_msg.h
    37	 * rpc message definition
    38	 *
    39	 * Copyright (C) 1984, Sun Microsystems, Inc.
    40	 */
    41	
    42	#ifndef _TIRPC_RPC_MSG_H
    43	#define _TIRPC_RPC_MSG_H
    44	
    45	#define RPC_MSG_VERSION		((u_int32_t) 2)
    46	#define RPC_SERVICE_PORT	((u_short) 2048)
    47	
    48	#include <rpc/auth.h>
    49	
    50	/*
    51	 * Bottom up definition of an rpc message.
    52	 * NOTE: call and reply use the same overall stuct but
    53	 * different parts of unions within it.
    54	 */
    55	
    56	enum msg_type {
    57		CALL=0,
    58		REPLY=1
    59	};
    60	
    61	enum reply_stat {
    62		MSG_ACCEPTED=0,
    63		MSG_DENIED=1
    64	};
    65	
    66	enum accept_stat {
    67		SUCCESS=0,
    68		PROG_UNAVAIL=1,
    69		PROG_MISMATCH=2,
    70		PROC_UNAVAIL=3,
    71		GARBAGE_ARGS=4,
    72		SYSTEM_ERR=5
    73	};
    74	
    75	enum reject_stat {
    76		RPC_MISMATCH=0,
    77		AUTH_ERROR=1
    78	};
    79	
    80	/*
    81	 * Reply part of an rpc exchange
    82	 */
    83	
    84	/*
    85	 * Reply to an rpc request that was accepted by the server.
    86	 * Note: there could be an error even though the request was
    87	 * accepted.
    88	 */
    89	struct accepted_reply {
    90		struct opaque_auth	ar_verf;
    91		enum accept_stat	ar_stat;
    92		union {
    93			struct {
    94				rpcvers_t low;
    95				rpcvers_t high;
    96			} AR_versions;
    97			struct {
    98				caddr_t	where;
    99				xdrproc_t proc;
   100			} AR_results;
   101			/* and many other null cases */
   102		} ru;
   103	#define	ar_results	ru.AR_results
   104	#define	ar_vers		ru.AR_versions
   105	};
   106	
   107	/*
   108	 * Reply to an rpc request that was rejected by the server.
   109	 */
   110	struct rejected_reply {
   111		enum reject_stat rj_stat;
   112		union {
   113			struct {
   114				rpcvers_t low;
   115				rpcvers_t high;
   116			} RJ_versions;
   117			enum auth_stat RJ_why;  /* why authentication did not work */
   118		} ru;
   119	#define	rj_vers	ru.RJ_versions
   120	#define	rj_why	ru.RJ_why
   121	};
   122	
   123	/*
   124	 * Body of a reply to an rpc request.
   125	 */
   126	struct reply_body {
   127		enum reply_stat rp_stat;
   128		union {
   129			struct accepted_reply RP_ar;
   130			struct rejected_reply RP_dr;
   131		} ru;
   132	#define	rp_acpt	ru.RP_ar
   133	#define	rp_rjct	ru.RP_dr
   134	};
   135	
   136	/*
   137	 * Body of an rpc request call.
   138	 */
   139	struct call_body {
   140		rpcvers_t cb_rpcvers;	/* must be equal to two */
   141		rpcprog_t cb_prog;
   142		rpcvers_t cb_vers;
   143		rpcproc_t cb_proc;
   144		struct opaque_auth cb_cred;
   145		struct opaque_auth cb_verf; /* protocol specific - provided by client */
   146	};
   147	
   148	/*
   149	 * The rpc message
   150	 */
   151	struct rpc_msg {
   152		u_int32_t		rm_xid;
   153		enum msg_type		rm_direction;
   154		union {
   155			struct call_body RM_cmb;
   156			struct reply_body RM_rmb;
   157		} ru;
   158	#define	rm_call		ru.RM_cmb
   159	#define	rm_reply	ru.RM_rmb
   160	};
   161	#define	acpted_rply	ru.RM_rmb.ru.RP_ar
   162	#define	rjcted_rply	ru.RM_rmb.ru.RP_dr
   163	
   164	#ifdef __cplusplus
   165	extern "C" {
   166	#endif
   167	/*
   168	 * XDR routine to handle a rpc message.
   169	 * xdr_callmsg(xdrs, cmsg)
   170	 * 	XDR *xdrs;
   171	 * 	struct rpc_msg *cmsg;
   172	 */
   173	extern bool_t	xdr_callmsg(XDR *, struct rpc_msg *);
   174	
   175	/*
   176	 * XDR routine to pre-serialize the static part of a rpc message.
   177	 * xdr_callhdr(xdrs, cmsg)
   178	 * 	XDR *xdrs;
   179	 * 	struct rpc_msg *cmsg;
   180	 */
   181	extern bool_t	xdr_callhdr(XDR *, struct rpc_msg *);
   182	
   183	/*
   184	 * XDR routine to handle a rpc reply.
   185	 * xdr_replymsg(xdrs, rmsg)
   186	 * 	XDR *xdrs;
   187	 * 	struct rpc_msg *rmsg;
   188	 */
   189	extern bool_t	xdr_replymsg(XDR *, struct rpc_msg *);
   190	
   191	
   192	/*
   193	 * XDR routine to handle an accepted rpc reply.
   194	 * xdr_accepted_reply(xdrs, rej)
   195	 * 	XDR *xdrs;
   196	 * 	struct accepted_reply *rej;
   197	 */
   198	extern bool_t	xdr_accepted_reply(XDR *, struct accepted_reply *);
   199	
   200	/*
   201	 * XDR routine to handle a rejected rpc reply.
   202	 * xdr_rejected_reply(xdrs, rej)
   203	 * 	XDR *xdrs;
   204	 * 	struct rejected_reply *rej;
   205	 */
   206	extern bool_t	xdr_rejected_reply(XDR *, struct rejected_reply *);
   207	
   208	/*
   209	 * Fills in the error part of a reply message.
   210	 * _seterr_reply(msg, error)
   211	 * 	struct rpc_msg *msg;
   212	 * 	struct rpc_err *error;
   213	 */
   214	extern void	_seterr_reply(struct rpc_msg *, struct rpc_err *);
   215	#ifdef __cplusplus
   216	}
   217	#endif
   218	
   219	#endif /* !_TIRPC_RPC_MSG_H */