Imported Upstream version 3.3.3
[debian/amanda] / common-src / dgram.h
1 /*
2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
3  * Copyright (c) 1991-1999 University of Maryland at College Park
4  * Copyright (c) 2007-2012 Zmanda, Inc.  All Rights Reserved.
5  * All Rights Reserved.
6  *
7  * Permission to use, copy, modify, distribute, and sell this software and its
8  * documentation for any purpose is hereby granted without fee, provided that
9  * the above copyright notice appear in all copies and that both that
10  * copyright notice and this permission notice appear in supporting
11  * documentation, and that the name of U.M. not be used in advertising or
12  * publicity pertaining to distribution of the software without specific,
13  * written prior permission.  U.M. makes no representations about the
14  * suitability of this software for any purpose.  It is provided "as is"
15  * without express or implied warranty.
16  *
17  * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
19  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
21  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
22  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23  *
24  * Author: James da Silva, Systems Design and Analysis Group
25  *                         Computer Science Department
26  *                         University of Maryland at College Park
27  */
28 /*
29  * $Id: dgram.h,v 1.15 2006/05/25 01:47:11 johnfranks Exp $
30  *
31  * interface for datagram module
32  */
33 #ifndef DGRAM_H
34 #define DGRAM_H
35
36 #include "amanda.h"
37
38 /*
39  * Maximum datagram (UDP packet) we can generate.  Size is limited by
40  * a 16 bit length field in an IPv4 header (65535), which must include
41  * the 24 byte IP header and the 8 byte UDP header.
42  */
43 #define MAX_DGRAM      (((1<<16)-1)-24-8)
44
45 typedef struct dgram_s {
46     char *cur;
47     int socket;
48     size_t len;
49     char data[MAX_DGRAM+1];
50 } dgram_t;
51
52 int     dgram_bind(dgram_t *dgram, sa_family_t family, in_port_t *portp);
53 void    dgram_socket(dgram_t *dgram, int sock);
54 int     dgram_send_addr(sockaddr_union *addr, dgram_t *dgram);
55 ssize_t dgram_recv(dgram_t *dgram, int timeout,
56                    sockaddr_union *fromaddr);
57 void    dgram_zero(dgram_t *dgram);
58 int     dgram_cat(dgram_t *dgram, const char *fmt, ...)
59      G_GNUC_PRINTF(2,3);
60 void dgram_eatline(dgram_t *dgram);
61
62 #endif /* ! DGRAM_H */