summaryrefslogtreecommitdiffstats
path: root/tcps_sess.h
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2008-03-02 10:19:25 +0000
committerRainer Gerhards <rgerhards@adiscon.com>2008-03-02 10:19:25 +0000
commit9d8eb28ebd941694d8dcbc66c6e5c80cf90a206d (patch)
tree7b6e8cc1a84ea7234a57ce4d85131819d820b292 /tcps_sess.h
parentb494d54b98e6240a20f494ecaa0bad646c531686 (diff)
downloadrsyslog-9d8eb28ebd941694d8dcbc66c6e5c80cf90a206d.zip
rsyslog-9d8eb28ebd941694d8dcbc66c6e5c80cf90a206d.tar.gz
rsyslog-9d8eb28ebd941694d8dcbc66c6e5c80cf90a206d.tar.xz
- added class tcps
- added class tcps_sess - changed imtcp to use new classes; seems to work; imgssapi currently broken
Diffstat (limited to 'tcps_sess.h')
-rw-r--r--tcps_sess.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/tcps_sess.h b/tcps_sess.h
new file mode 100644
index 0000000..d3dc9c6
--- /dev/null
+++ b/tcps_sess.h
@@ -0,0 +1,73 @@
+/* Definitions for tcps_sess class. This implements a session of the
+ * plain TCP server.
+ *
+ * Copyright 2008 Rainer Gerhards and Adiscon GmbH.
+ *
+ * This file is part of rsyslog.
+ *
+ * Rsyslog is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Rsyslog 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Rsyslog. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * A copy of the GPL can be found in the file "COPYING" in this distribution.
+ */
+#ifndef INCLUDED_TCPS_SESS_H
+#define INCLUDED_TCPS_SESS_H
+
+#include "obj.h"
+
+/* framing modes for TCP */
+typedef enum _TCPFRAMINGMODE {
+ TCP_FRAMING_OCTET_STUFFING = 0, /* traditional LF-delimited */
+ TCP_FRAMING_OCTET_COUNTING = 1 /* -transport-tls like octet count */
+ } TCPFRAMINGMODE;
+
+/* the tcps_sess object */
+typedef struct tcps_sess_s {
+ BEGINobjInstance; /* Data to implement generic object - MUST be the first data element! */
+ int sock;
+ int iMsg; /* index of next char to store in msg */
+ int bAtStrtOfFram; /* are we at the very beginning of a new frame? */
+ int iOctetsRemain; /* Number of Octets remaining in message */
+ TCPFRAMINGMODE eFraming;
+ char msg[MAXLINE+1];
+ char *fromHost;
+ void *pUsr; /* a user-pointer */
+ /* callbacks */
+ rsRetVal (*pOnTCPSessConstruct)(void*);
+ rsRetVal (*pOnTCPSessConstructFinalize)(void*);
+ rsRetVal (*pOnTCPSessDestruct)(void*);
+} tcps_sess_t;
+
+
+/* interfaces */
+BEGINinterface(tcps_sess) /* name must also be changed in ENDinterface macro! */
+ INTERFACEObjDebugPrint(tcps_sess);
+ rsRetVal (*Construct)(tcps_sess_t **ppThis);
+ rsRetVal (*ConstructFinalize)(tcps_sess_t __attribute__((unused)) *pThis);
+ rsRetVal (*Destruct)(tcps_sess_t **ppThis);
+ rsRetVal (*PrepareClose)(tcps_sess_t *pThis);
+ rsRetVal (*Close)(tcps_sess_t *pThis);
+ rsRetVal (*DataRcvd)(tcps_sess_t *pThis, char *pData, size_t iLen);
+ /* set methods */
+ rsRetVal (*SetHost)(tcps_sess_t *pThis, uchar*);
+ rsRetVal (*SetSock)(tcps_sess_t *pThis, int);
+ rsRetVal (*SetMsgIdx)(tcps_sess_t *pThis, int);
+ENDinterface(tcps_sess)
+#define tcps_sessCURR_IF_VERSION 1 /* increment whenever you change the interface structure! */
+
+
+/* prototypes */
+PROTOTYPEObj(tcps_sess);
+
+
+#endif /* #ifndef INCLUDED_TCPS_SESS_H */