1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* Definitions for the stream-based netstrmworking class.
*
* Copyright 2007, 2008 Rainer Gerhards and Adiscon GmbH.
*
* This file is part of the rsyslog runtime library.
*
* The rsyslog runtime library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The rsyslog runtime library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with the rsyslog runtime library. If not, see <http://www.gnu.org/licenses/>.
*
* A copy of the GPL can be found in the file "COPYING" in this distribution.
* A copy of the LGPL can be found in the file "COPYING.LESSER" in this distribution.
*/
#ifndef INCLUDED_NETSTRM_H
#define INCLUDED_NETSTRM_H
#include "nsd.h" /* we need our driver interface to be defined */
/* the netstrm object */
struct netstrm_s {
BEGINobjInstance; /* Data to implement generic object - MUST be the first data element! */
nsd_t *pDrvrData; /**< the driver's data elements */
uchar *pDrvrName; /**< nsd driver name to use, or NULL if system default */
nsd_if_t Drvr; /**< our stream driver */
/* for listeners, we need to have the capablity to listen on multiple "sockets". This
* is needed to support IPv6. We do this by specifying an array of nsd_t objects to
* handle this case.
*/
int isizeLstnArr;
nsd_t **parrLstn;
};
/* a helper object enabling us to wait on a set of streams to become
* ready for IO - this is modelled after select(). We need this, because
* stream drivers may have different concepts. Consequently,
* the structure must contain nsd_t's from the same stream driver type
* only. This is implemented as a singly-linked list where every
* new element is added at the top of the list. -- rgerhards, 2008-04-22
*/
typedef struct netstrm_iowaiter_s netstrm_iowaiter_t;
struct netstrm_iowaiter_s {
netstrm_iowaiter_t *pNext;
nsd_t *pNsd;
enum {
NETSTRM_IOWAIT_RD = 1,
NETSTRM_IOWAIT_WR = 2,
NETSTRM_IOWAIT_RDWR = 3
} waitOp; /**< the operation we wait for */
};
/* interface */
BEGINinterface(netstrm) /* name must also be changed in ENDinterface macro! */
rsRetVal (*Construct)(netstrm_t **ppThis);
rsRetVal (*ConstructFinalize)(netstrm_t *pThis);
rsRetVal (*Destruct)(netstrm_t **ppThis);
rsRetVal (*AbortDestruct)(netstrm_t **ppThis);
rsRetVal (*LstnInit)(netstrm_t *pThis, uchar *pLstnPort, uchar *pLstnIP, int iSessMax);
rsRetVal (*AcceptConnReq)(netstrm_t *pThis, nsd_t *pReqNsd, netstrm_t **ppNew);
rsRetVal (*Rcv)(netstrm_t *pThis, uchar *pRcvBuf, ssize_t *pLenBuf);
rsRetVal (*Send)(netstrm_t *pThis, uchar *pBuf, ssize_t *pLenBuf);
rsRetVal (*Connect)(netstrm_t *pThis, int family, unsigned char *port, unsigned char *host);
rsRetVal (*SelectInit)(nsdsel_t **ppSel, netstrm_t *pThis);
rsRetVal (*SelectAdd)(nsdsel_t *pSel, netstrm_t *pThis);
rsRetVal (*SelectWait)(nsdsel_t *pSel, int *piNumReady);
rsRetVal (*SelectIsReady)(nsdsel_t *pSel, int *piNumReady);
rsRetVal (*SelectExit)(nsdsel_t **ppSel);
ENDinterface(netstrm)
#define netstrmCURR_IF_VERSION 1 /* increment whenever you change the interface structure! */
/* prototypes */
PROTOTYPEObj(netstrm);
/* the name of our library binary */
#define LM_NETSTRM_FILENAME "lmnetstrm"
#endif /* #ifndef INCLUDED_NETSTRM_H */
|
