// Sample code file: RPC_MSG.H

// Warning: This code has been marked up for HTML

/*
//ÉÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ»
//º (c) 1995 Novell, Inc.  All rights reserved.                              º
//º                                                                          º
//º THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND        º
//º TREATIES.                                                                º
//º                                                                          º
//º NO PART OF THIS WORK MAY BE USED, PRACTICED, PERFORMED, COPIED,          º
//º DISTRIBUTED, REVISED, MODIFIED, TRANSLATED, ABRIDGED, CONDENSED,         º
//º EXPANDED, COLLECTED, COMPILED, LINKED, RECAST, TRANSFORMED OR ADAPTED    º
//º WITHOUT THE PRIOR WRITTEN CONSENT OF NOVELL, INC.                        º
//º                                                                          º
//º ANY USE OR EXPLOITATION OF THIS WORK WITHOUT AUTHORIZATION COULD SUBJECT º
//º THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.                         º
//ÌÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍ͹
//º Source module name: RPC_MSG.H                                            º
//ÈÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍÍͼ
*/
/* Inclusion Control */
#if !defined( _RPC_RPC_MSG_H )
   #define _RPC_RPC_MSG_H

#include <rpc/ndpsrpc.h>

#if defined(NWDOS) || defined(N_PLAT_DOS)

#include <limits.h>           /* INT_MAX                                */

#ifndef _RPC_TYPES_H
#include <rpc/types.h>
#endif

#ifndef _RPC_XDR_H
#include <rpc/xdr.h>
#endif

#ifndef _RPC_AUTH_H
#include <rpc/auth.h>
#endif

#ifndef _RPC_CLNT_H
#include <rpc/clnt.h>
#endif

#define RPC_MSG_VERSION    ((u_long)2)
#define RPC_SERVICE_PORT   ((u_short)2048)

/*
 * Bottom up definition of an rpc message.
 * NOTE: call and reply use the same overall stuct but
 * different parts of unions within it.
 */
enum msg_type {
   CALL         = 0,
   REPLY        = 1,
   MK_LONG      = INT_MAX
};

enum reply_stat {
   MSG_ACCEPTED = 0,
   MSG_DENIED   = 1,
   RMK_LONG     = INT_MAX 
};

enum accept_stat {
   SUCCESS      = 0,
   PROG_UNAVAIL = 1,
   PROG_MISMATCH= 2,
   PROC_UNAVAIL = 3,
   GARBAGE_ARGS = 4,
   SYSTEM_ERR   = 5,
   AMK_LONG     = INT_MAX
};

enum reject_stat {
   RPC_MISMATCH = 0,
   AUTH_ERROR   = 1,
   RJMK_LONG    = INT_MAX
};

/*
 * Reply part of an rpc exchange
 */

/*
 * Reply to an rpc request that was accepted by the server.
 * Note: there could be an error even though the request was
 * accepted.
 */
struct accepted_reply {
   struct opaque_auth   ar_verf;
   enum accept_stat     ar_stat;
   union {
      struct {
         u_long  low;
         u_long  high;
      } AR_versions;
      struct {
         caddr_t     where;
         xdrproc_t   proc;
      } AR_results;
      /* and many other null cases */
   } ru;
#define  ar_results  ru.AR_results
#define  ar_vers     ru.AR_versions
};

/*
 * Reply to an rpc request that was rejected by the server.
 */
struct rejected_reply {
   enum reject_stat rj_stat;
   union {
      struct {
         u_long low;
         u_long high;
      } RJ_versions;
      enum auth_stat RJ_why;  /* why authentication did not work */
   } ru;
#define  rj_vers  ru.RJ_versions
#define  rj_why   ru.RJ_why
};

/*
 * Body of a reply to an rpc request.
 */
struct reply_body {
   enum reply_stat rp_stat;
   union {
      struct accepted_reply RP_ar;
      struct rejected_reply RP_dr;
   } ru;
#define  rp_acpt  ru.RP_ar
#define  rp_rjct  ru.RP_dr
};

/*
 * Body of an rpc request call.
 */
struct call_body {
   u_long             cb_rpcvers;  /* must be equal to two */
   u_long             cb_prog;
   u_long             cb_vers;
   u_long             cb_proc;
   struct opaque_auth cb_cred;
   struct opaque_auth cb_verf; /* protocol specific - provided by client */
};

/*
 * The rpc message
 */
struct rpc_msg {
   u_long               rm_xid;
   enum msg_type        rm_direction;
   union {
      struct call_body  RM_cmb;
      struct reply_body RM_rmb;
   } ru;
#define  rm_call     ru.RM_cmb
#define  rm_reply    ru.RM_rmb
};
#define  acpted_rply    ru.RM_rmb.ru.RP_ar
#define  rjcted_rply    ru.RM_rmb.ru.RP_dr


#ifdef __cplusplus
extern "C" {
#endif

bool_t  xdr_callmsg( XDR far *, struct rpc_msg far * );
bool_t  xdr_opaque_auth( XDR far *, struct opaque_auth far * );
bool_t  xdr_callhdr( XDR far *, struct rpc_msg far * );
bool_t  xdr_replymsg( XDR far *, struct rpc_msg far * );
void    _seterr_reply( struct rpc_msg far *, struct rpc_err far * );

#ifdef  __cplusplus
}
#endif

#endif /* NWDOS */


#if defined(NWWIN) || defined(N_PLAT_MSW) || defined(N_PLAT_MSW4)

#define RPC_MSG_VERSION      ((unsigned long) 2)

#include <rpc/xdr.h>

/*
 * Bottom up definition of an rpc message.
 * NOTE: call and reply use the same overall stuct but
 * different parts of unions within it.
 */

enum msg_type {
   CALL=0,
   REPLY=1,
        MK_LONG = 0x1000
};

enum reply_stat {
   MSG_ACCEPTED=0,
   MSG_DENIED=1,
        RMK_LONG = 0x1000
};

enum accept_stat {
   SUCCESS=0,
   PROG_UNAVAIL=1,
   PROG_MISMATCH=2,
   PROC_UNAVAIL=3,
   GARBAGE_ARGS=4,
   SYSTEM_ERR=5,
        AMK_LONG = 0x1000
};

enum reject_stat {
   RPC_MISMATCH=0,
   AUTH_ERROR=1,
        RJMK_LONG = 0x1000
};

/*
 * Reply part of an rpc exchange
 */

/*
 * Reply to an rpc request that was accepted by the server.
 * Note: there could be an error even though the request was
 * accepted.
 */
struct accepted_reply {
   struct opaque_auth   ar_verf;
   enum accept_stat   ar_stat;
   union {
      struct {
         unsigned long   low;
         unsigned long   high;
      } AR_versions;
      struct {
         caddr_t   where;
         xdrproc_t proc;
      } AR_results;
      /* and many other null cases */
   } ru;
#define   ar_results   ru.AR_results
#define   ar_vers      ru.AR_versions
};

/*
 * Reply to an rpc request that was rejected by the server.
 */
struct rejected_reply {
   enum reject_stat rj_stat;
   union {
      struct {
         unsigned long low;
         unsigned long high;
      } RJ_versions;
      enum auth_stat RJ_why;  /* why authentication did not work */
   } ru;
#define   rj_vers   ru.RJ_versions
#define   rj_why   ru.RJ_why
};

/*
 * Body of a reply to an rpc request.
 */
struct reply_body {
   enum reply_stat rp_stat;
   union {
      struct accepted_reply RP_ar;
      struct rejected_reply RP_dr;
   } ru;
#define   rp_acpt   ru.RP_ar
#define   rp_rjct   ru.RP_dr
};

/*
 * Body of an rpc request call.
 */
struct call_body {
   unsigned long cb_rpcvers;   /* must be equal to two */
   unsigned long cb_prog;
   unsigned long cb_vers;
   unsigned long cb_proc;
   struct opaque_auth cb_cred;
   struct opaque_auth cb_verf; /* protocol specific - provided by client */
};

/*
 * The rpc message
 */
struct rpc_msg {
   unsigned long            rm_xid;
   enum msg_type        rm_direction;
   union {
      struct call_body RM_cmb;
      struct reply_body RM_rmb;
   } ru;
#define   rm_call      ru.RM_cmb
#define   rm_reply   ru.RM_rmb
};
#define   acpted_rply   ru.RM_rmb.ru.RP_ar
#define   rjcted_rply   ru.RM_rmb.ru.RP_dr


/*
 * XDR routine to handle a rpc message.
 * xdr_callmsg(xdrs, cmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *cmsg;
 */
extern bool_t N_API
xdr_callmsg(XDR FAR *,struct rpc_msg FAR *);


/* XDR an opaque authentication struct 
 *
 * xdr_opaque_auth(xdrs, ap)
 *   register XDR *xdrs;
 *   register struct opaque_auth *ap;
 */
extern bool_t N_API
xdr_opaque_auth(XDR FAR *,struct opaque_auth FAR *);


/*
 * XDR routine to pre-serialize the static part of a rpc message.
 * xdr_callhdr(xdrs, cmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *cmsg;
 */
extern bool_t N_API 
xdr_callhdr(XDR FAR *,struct rpc_msg FAR *);

/*
 * XDR routine to handle a rpc reply.
 * xdr_replymsg(xdrs, rmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *rmsg;
 */
extern bool_t N_API
xdr_replymsg(XDR FAR *,struct rpc_msg FAR *);

/*
 * Fills in the error part of a reply message.
 * _seterr_reply(msg, error)
 *    struct rpc_msg *msg;
 *    struct rpc_err *error;
 */
extern void N_API
_seterr_reply(struct rpc_msg FAR *,struct rpc_err FAR *);

#endif /* NWWIN */


#if defined(NWNLM) || defined(N_PLAT_NLM) || defined(N_PLAT_NIOS)

#ifndef _LIMITS_H_INCLUDED
#include <limits.h>
#endif
#ifndef _RPC_XDR_H
#include <rpc/xdr.h>
#endif
#ifndef _RPC_AUTH_H
#include <rpc/auth.h>
#endif

#define RPC_MSG_VERSION      ((unsigned long) 2)
//#define RPC_SERVICE_PORT   ((u_short) 2048)

/*
 * Bottom up definition of an rpc message.
 * NOTE: call and reply use the same overall stuct but
 * different parts of unions within it.
 */

enum msg_type {
   CALL=0,
   REPLY=1,
        MK_LONG = INT_MIN
};

enum reply_stat {
   MSG_ACCEPTED=0,
   MSG_DENIED=1,
        RMK_LONG = INT_MIN
};

enum accept_stat {
   SUCCESS=0,
   PROG_UNAVAIL=1,
   PROG_MISMATCH=2,
   PROC_UNAVAIL=3,
   GARBAGE_ARGS=4,
   SYSTEM_ERR=5,
        AMK_LONG = INT_MIN
};

enum reject_stat {
   RPC_MISMATCH=0,
   AUTH_ERROR=1,
        RJMK_LONG = INT_MIN
};

/*
 * Reply part of an rpc exchange
 */

/*
 * Reply to an rpc request that was accepted by the server.
 * Note: there could be an error even though the request was
 * accepted.
 */
struct accepted_reply {
   struct opaque_auth   ar_verf;
   enum accept_stat   ar_stat;
   union {
      struct {
         unsigned long   low;
         unsigned long   high;
      } AR_versions;
      struct {
         caddr_t   where;
         xdrproc_t proc;
      } AR_results;
      /* and many other null cases */
   } ru;
#define   ar_results   ru.AR_results
#define   ar_vers      ru.AR_versions
};

/*
 * Reply to an rpc request that was rejected by the server.
 */
struct rejected_reply {
   enum reject_stat rj_stat;
   union {
      struct {
         unsigned long low;
         unsigned long high;
      } RJ_versions;
      enum auth_stat RJ_why;  /* why authentication did not work */
   } ru;
#define   rj_vers   ru.RJ_versions
#define   rj_why   ru.RJ_why
};

/*
 * Body of a reply to an rpc request.
 */
struct reply_body {
   enum reply_stat rp_stat;
   union {
      struct accepted_reply RP_ar;
      struct rejected_reply RP_dr;
   } ru;
#define   rp_acpt   ru.RP_ar
#define   rp_rjct   ru.RP_dr
};

/*
 * Body of an rpc request call.
 */
struct call_body {
   unsigned long cb_rpcvers;   /* must be equal to two */
   unsigned long cb_prog;
   unsigned long cb_vers;
   unsigned long cb_proc;
   struct opaque_auth cb_cred;
   struct opaque_auth cb_verf; /* protocol specific - provided by client */
};

/*
 * The rpc message
 */
struct rpc_msg {
   unsigned long            rm_xid;
   enum msg_type        rm_direction;
   union {
      struct call_body RM_cmb;
      struct reply_body RM_rmb;
   } ru;
#define   rm_call      ru.RM_cmb
#define   rm_reply   ru.RM_rmb
};
#define   acpted_rply   ru.RM_rmb.ru.RP_ar
#define   rjcted_rply   ru.RM_rmb.ru.RP_dr


/*
 * XDR routine to handle a rpc message.
 * xdr_callmsg(xdrs, cmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *cmsg;
 */
extern bool_t   xdr_callmsg(XDR *, struct rpc_msg *);


/* XDR an opaque authentication struct 
 *
 * xdr_opaque_auth(xdrs, ap)
 *   register XDR *xdrs;
 *   register struct opaque_auth *ap;
 */
extern bool_t   xdr_opaque_auth(XDR *, struct opaque_auth *);


/*
 * XDR routine to pre-serialize the static part of a rpc message.
 * xdr_callhdr(xdrs, cmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *cmsg;
 */
extern bool_t   xdr_callhdr(XDR *, struct rpc_msg *);

/*
 * XDR routine to handle a rpc reply.
 * xdr_replymsg(xdrs, rmsg)
 *    XDR *xdrs;
 *    struct rpc_msg *rmsg;
 */
extern bool_t   xdr_replymsg(XDR *, struct rpc_msg *);

/*
 * Fills in the error part of a reply message.
 * _seterr_reply(msg, error)
 *    struct rpc_msg *msg;
 *    struct rpc_err *error;
 */
extern void   _seterr_reply(struct rpc_msg *,struct rpc_err *);

#endif /* NWNLM */ /* N_PLAT_NLM */ /* N_PLAT_NIOS */


#endif /* _RPC_RPC_MSG_H */