fb126261037e4319845a9b67c23977ad6ef12663
[debian/amanda] / 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.6 2004/02/13 14:00:35 martinea Exp $
28  *
29  * interfaces for modifying amanda protocol packet type
30  */
31 #ifndef PACKET_H
32 #define PACKET_H
33
34 /*
35  * We limit our body length to 50k.
36  */
37 #define MAX_PACKET      (50*1024)
38
39 typedef enum { P_REQ = 0, P_REP = 1, P_PREP = 2, P_ACK = 3, P_NAK = 4 } pktype_t;
40 typedef struct {
41     pktype_t type;                              /* type of packet */
42     char body[MAX_PACKET];                      /* body of packet */
43 } pkt_t;
44
45 /*
46  * Initialize a packet
47  */
48 void pkt_init P((pkt_t *, pktype_t, const char *, ...))
49     __attribute__ ((format (printf, 3, 4)));
50
51 /*
52  * Append data to a packet
53  */
54 void pkt_cat P((pkt_t *, const char *, ...))
55     __attribute__ ((format (printf, 2, 3)));
56
57 /*
58  * Convert the packet type to and from a string
59  */
60 const char *pkt_type2str P((pktype_t));
61 pktype_t pkt_str2type P((const char *));
62
63 #endif /* PACKET_H */