git.gag.com Git - debian/amanda/blob - common-src/packet.h

   1 /*
   2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
   3  * Copyright (c) 1991-1999 University of Maryland at College Park
   4  * All Rights Reserved.
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation, and that the name of U.M. not be used in advertising or
  11  * publicity pertaining to distribution of the software without specific,
  12  * written prior permission.  U.M. makes no representations about the
  13  * suitability of this software for any purpose.  It is provided "as is"
  14  * without express or implied warranty.
  15  *
  16  * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
  18  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  19  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  20  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  22  *
  23  * Authors: the Amanda Development Team.  Its members are listed in a
  24  * file named AUTHORS, in the root directory of this distribution.
  25  */
  26 /*
  27  * $Id: packet.h,v 1.8 2006/05/25 01:47:12 johnfranks Exp $
  28  *
  29  * interfaces for modifying amanda protocol packet type
  30  */
  31 #ifndef PACKET_H
  32 #define PACKET_H
  33
  34 typedef enum { P_REQ = 0, P_REP = 1, P_PREP = 2, P_ACK = 3, P_NAK = 4 } pktype_t;
  35 typedef struct {
  36     pktype_t    type;                   /* type of packet */
  37     char *      body;                   /* body of packet */
  38     size_t      size;
  39     size_t      packet_size;
  40 } pkt_t;
  41
  42 /*
  43  * Initialize a packet
  44  */
  45 void pkt_init_empty(pkt_t *pkt, pktype_t type);
  46 void pkt_init(pkt_t *, pktype_t, const char *, ...)
  47      G_GNUC_PRINTF(3,4);
  48
  49 /*
  50  * Append data to a packet
  51  */
  52 void pkt_cat(pkt_t *, const char *, ...)
  53      G_GNUC_PRINTF(2,3);
  54
  55 /*
  56  * Convert the packet type to and from a string
  57  */
  58 const char *pkt_type2str(pktype_t);
  59 pktype_t pkt_str2type(const char *);
  60
  61 #endif /* PACKET_H */