2 * Bacula Sock Structure definition
6 * Zero msglen from other end indicates soft eof (usually
7 * end of some binary data stream, but not end of conversation).
9 * Negative msglen, is special "signal" (no data follows).
10 * See below for SIGNAL codes.
15 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
17 This program is free software; you can redistribute it and/or
18 modify it under the terms of the GNU General Public License as
19 published by the Free Software Foundation; either version 2 of
20 the License, or (at your option) any later version.
22 This program is distributed in the hope that it will be useful,
23 but WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 General Public License for more details.
27 You should have received a copy of the GNU General Public
28 License along with this program; if not, write to the Free
29 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
34 typedef struct s_bsock {
35 uint64_t read_seqno; /* read sequence number */
36 uint32_t in_msg_no; /* intput message number */
37 uint32_t out_msg_no; /* output message number */
38 int fd; /* socket file descriptor */
39 int32_t msglen; /* message length */
40 int port; /* desired port */
41 int errors; /* set if errors on socket */
42 int b_errno; /* bsock errno */
43 time_t timer_start; /* time started read/write */
44 int timed_out; /* timed out in read/write */
45 int timeout; /* time out after this value */
46 int terminated; /* set when BNET_TERMINATE arrives */
47 int duped; /* set if duped BSOCK */
48 POOLMEM *msg; /* message pool buffer */
49 char *who; /* Name of daemon to which we are talking */
50 char *host; /* Host name/IP */
51 POOLMEM *errmsg; /* edited error message (to be implemented) */
52 RES *res; /* Resource to which we are connected */
53 struct s_bsock *next; /* next BSOCK if duped */
54 int spool; /* set for spooling */
55 FILE *spool_fd; /* spooling file */
58 /* Signal definitions for use in bnet_sig() */
59 #define BNET_NONO 0 /* DO NOT USE, remains for compatibility */
60 #define BNET_EOD -1 /* End of data stream, new data may follow */
61 #define BNET_EOD_POLL -2 /* End of data and poll all in one */
62 #define BNET_STATUS -3 /* Send full status */
63 #define BNET_TERMINATE -4 /* Conversation terminated, doing close() */
64 #define BNET_POLL -5 /* Poll request, I'm hanging on a read */
65 #define BNET_HEARTBEAT -6 /* Heartbeat Response requested */
66 #define BNET_HB_RESPONSE -7 /* Only response permited to HB */
67 #define BNET_PROMPT -8 /* Prompt for UA */
69 #define BNET_SETBUF_READ 1 /* Arg for bnet_set_buffer_size */
70 #define BNET_SETBUF_WRITE 2 /* Arg for bnet_set_buffer_size */
73 * This is the structure of the in memory BPKT
75 typedef struct s_bpkt {
76 char *id; /* String identifier or name of field */
77 uint8_t type; /* field type */
78 uint32_t len; /* field length for string, name, bytes */
79 void *value; /* pointer to value */
83 * These are the data types that can be sent.
84 * For all values other than string, the storage space
85 * is assumed to be allocated in the receiving packet.
86 * For BP_STRING if the *value is non-zero, it is a
87 * pointer to a POOLMEM buffer, and the Memory Pool
88 * routines will be used to assure that the length is
89 * adequate. NOTE!!! This pointer will be changed
90 * if the memory is reallocated (sort of like Mmsg(&pool)
91 * does). If the pointer is NULL, a POOLMEM
92 * buffer will be allocated.
94 #define BP_EOF 0 /* end of file */
95 #define BP_CHAR 1 /* Character */
96 #define BP_INT32 1 /* 32 bit integer */
97 #define BP_UINT32 3 /* Unsigned 32 bit integer */
98 #define BP_INT64 4 /* 64 bit integer */
99 #define BP_STRING 5 /* string */
100 #define BP_NAME 6 /* Name string -- limited length */
101 #define BP_BYTES 7 /* Binary bytes */
102 #define BP_FLOAT32 8 /* 32 bit floating point */
103 #define BP_FLOAT64 9 /* 64 bit floating point */