nnchat: libnnchat.h annotate

annotate libnnchat.h @ 168:2e4850ece456

Partially re-factor connection handling.

author	Matti Hamalainen <ccr@tnsp.org>
date	Sun, 14 Nov 2010 22:08:08 +0200
parents	741e45592522
children	7ba4e371e9a6

rev	line source
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	1 /*
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	2 * NNChat - Custom chat client for NewbieNudes.com chatrooms
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	3 * Written by Matti 'ccr' Hämäläinen
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	4 * (C) Copyright 2008-2010 Tecnic Software productions (TNSP)
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	5 */
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	6 #ifndef LIBNNCHAT_H
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	7 #define LIBNNCHAT_H
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	8
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	9 #include <stdio.h>
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	10 #include <unistd.h>
64 6a3a917303e4 Some random cleanups, bring back WinSock support. Matti Hamalainen <ccr@tnsp.org> parents: 62 diff changeset	11 #ifdef __WIN32
68 3ab7751fdad1 MingW compatibility, with one ugly kludge. Matti Hamalainen <ccr@tnsp.org> parents: 65 diff changeset	12 #include <windows.h>
64 6a3a917303e4 Some random cleanups, bring back WinSock support. Matti Hamalainen <ccr@tnsp.org> parents: 62 diff changeset	13 #include <winsock.h>
6a3a917303e4 Some random cleanups, bring back WinSock support. Matti Hamalainen <ccr@tnsp.org> parents: 62 diff changeset	14 #else
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	15 #include <sys/socket.h>
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	16 #include <arpa/inet.h>
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	17 #include <netdb.h>
64 6a3a917303e4 Some random cleanups, bring back WinSock support. Matti Hamalainen <ccr@tnsp.org> parents: 62 diff changeset	18 #endif
6a3a917303e4 Some random cleanups, bring back WinSock support. Matti Hamalainen <ccr@tnsp.org> parents: 62 diff changeset	19 #include <sys/types.h>
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	20 #include <time.h>
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	21 #include <errno.h>
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	22 #include "th_string.h"
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	23
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	24 #define NN_TMPBUF_SIZE (4096)
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	25 #define NN_ALLOC_SIZE (128)
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	26 #define NN_CONNBUF_SIZE (64 * 1024)
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	27 #define NN_NUM_BUCKETS (256)
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	28 #define NN_DELAY_USEC (15 * 250)
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	29
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	30 typedef struct {
71 3a23c2adfb78 Remove tabs from indentation. Matti Hamalainen <ccr@tnsp.org> parents: 68 diff changeset	31 char **data;
3a23c2adfb78 Remove tabs from indentation. Matti Hamalainen <ccr@tnsp.org> parents: 68 diff changeset	32 size_t n, size;
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	33 } nn_ringbuf_t;
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	34
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	35
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	36 typedef struct {
71 3a23c2adfb78 Remove tabs from indentation. Matti Hamalainen <ccr@tnsp.org> parents: 68 diff changeset	37 ssize_t pos, len, size;
3a23c2adfb78 Remove tabs from indentation. Matti Hamalainen <ccr@tnsp.org> parents: 68 diff changeset	38 char *data;
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	39 } nn_editbuf_t;
c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	40
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	41
94 6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	42 typedef struct _nn_user_t {
106 c587a99e2096 Drop internal use and storage of encoded usernames. Matti Hamalainen <ccr@tnsp.org> parents: 103 diff changeset	43 char *name;
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	44 time_t lastspoke, joined;
94 6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	45 struct _nn_user_t *next;
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	46 } nn_user_t;
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	47
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	48
94 6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	49
6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	50 typedef struct {
6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	51 nn_user_t *buckets[NN_NUM_BUCKETS];
6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	52 } nn_userhash_t;
6e47426efb6a Add preliminary userlist data handling functions. Matti Hamalainen <ccr@tnsp.org> parents: 91 diff changeset	53
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	54 enum {
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	55 NN_CONN_UNINIT = 0,
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	56 NN_CONN_OPEN,
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	57 NN_CONN_CLOSED
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	58 };
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	59
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	60 typedef struct _nn_conn_t {
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	61 int socket;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	62 int port;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	63 struct in_addr address;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	64 fd_set sockfds;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	65
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	66 void (errfunc)(struct _nn_conn_t conn, const char *fmt, va_list ap);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	67 void (msgfunc)(struct _nn_conn_t conn, const char *fmt, va_list ap);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	68
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	69 int err;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	70 int status;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	71
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	72 char buf[NN_CONNBUF_SIZE + 16];
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	73 char *ptr;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	74 ssize_t got;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	75 } nn_conn_t;
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	76
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	77
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	78 const char *nn_get_errstr(int err);
97 218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	79 BOOL nn_network_init(void);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	80 void nn_network_close(void);
90 1e0bf7b4fd41 Move socket error handling functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 89 diff changeset	81
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	82 nn_conn_t * nn_conn_open(struct in_addr *addr, const int port);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	83 void nn_conn_close(nn_conn_t *);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	84 BOOL nn_conn_pull(nn_conn_t *);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	85 BOOL nn_conn_send_buf(nn_conn_t , const char buf, const size_t len);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	86 BOOL nn_conn_send_msg(nn_conn_t , const char user, const char *fmt, ...);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	87 BOOL nn_conn_check(nn_conn_t *);
2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	88
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	89
103 eaa524e153f9 Initial implementation of functions for implementing tab-completion for user names. Matti Hamalainen <ccr@tnsp.org> parents: 102 diff changeset	90 nn_userhash_t *nn_userhash_new(void);
eaa524e153f9 Initial implementation of functions for implementing tab-completion for user names. Matti Hamalainen <ccr@tnsp.org> parents: 102 diff changeset	91 nn_user_t * nn_userhash_foreach(const nn_userhash_t , int (func)(const nn_user_t *));
116 741e45592522 Add simple "prediction" into tab-completion based on previously gotten last Matti Hamalainen <ccr@tnsp.org> parents: 106 diff changeset	92 nn_user_t * nn_user_match(const nn_userhash_t list, const char str, const char *current, BOOL again);
106 c587a99e2096 Drop internal use and storage of encoded usernames. Matti Hamalainen <ccr@tnsp.org> parents: 103 diff changeset	93 int nn_userhash_insert(nn_userhash_t , const char name);
c587a99e2096 Drop internal use and storage of encoded usernames. Matti Hamalainen <ccr@tnsp.org> parents: 103 diff changeset	94 int nn_userhash_delete(nn_userhash_t , const char name);
103 eaa524e153f9 Initial implementation of functions for implementing tab-completion for user names. Matti Hamalainen <ccr@tnsp.org> parents: 102 diff changeset	95 void nn_userhash_free(nn_userhash_t *);
eaa524e153f9 Initial implementation of functions for implementing tab-completion for user names. Matti Hamalainen <ccr@tnsp.org> parents: 102 diff changeset	96 void nn_user_free(nn_user_t *);
102 b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	97 void nn_user_free_list(nn_user_t *);
b096ae97fc7d Renamed functions. Matti Hamalainen <ccr@tnsp.org> parents: 97 diff changeset	98 nn_user_t * nn_user_copy(const nn_user_t *src);
106 c587a99e2096 Drop internal use and storage of encoded usernames. Matti Hamalainen <ccr@tnsp.org> parents: 103 diff changeset	99 nn_user_t * nn_user_find(const nn_userhash_t list, const char name);
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	100
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	101
97 218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	102 char * nn_encode_str1(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	103 char * nn_decode_str1(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	104 char * nn_encode_str2(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	105 char * nn_decode_str2(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	106 char * nn_strip_tags(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	107 char * nn_dbldecode_str(const char *str);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	108 char * nn_dblencode_str(const char *str);
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	109
89 c2d916b340bf Change some typedef names; Add struct for user list handling. Matti Hamalainen <ccr@tnsp.org> parents: 78 diff changeset	110
97 218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	111 nn_ringbuf_t * nn_ringbuf_new(const size_t size);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	112 void nn_ringbuf_free(nn_ringbuf_t *buf);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	113 void nn_ringbuf_add(nn_ringbuf_t buf, const char str);
65 e763ef5cfd53 Move more functions to libnnchat. Matti Hamalainen <ccr@tnsp.org> parents: 64 diff changeset	114
168 2e4850ece456 Partially re-factor connection handling. Matti Hamalainen <ccr@tnsp.org> parents: 116 diff changeset	115
97 218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	116 int nn_editbuf_write(nn_editbuf_t *buf, ssize_t pos, int ch);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	117 int nn_editbuf_insert(nn_editbuf_t *buf, ssize_t pos, int ch);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	118 int nn_editbuf_delete(nn_editbuf_t *buf, ssize_t pos);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	119 void nn_editbuf_clear(nn_editbuf_t *buf);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	120 nn_editbuf_t * nn_editbuf_new(ssize_t n);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	121 void nn_editbuf_free(nn_editbuf_t *buf);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	122 nn_editbuf_t * nn_editbuf_copy(nn_editbuf_t *src);
218efd2f0641 Rename functions for clarity. Matti Hamalainen <ccr@tnsp.org> parents: 94 diff changeset	123 void nn_editbuf_setpos(nn_editbuf_t *buf, ssize_t pos);
103 eaa524e153f9 Initial implementation of functions for implementing tab-completion for user names. Matti Hamalainen <ccr@tnsp.org> parents: 102 diff changeset	124 char * nn_editbuf_get_string(nn_editbuf_t *buf, ssize_t start, ssize_t end);
62 ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	125
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	126
ff5d74f0d428 Moved some functions to "libnnchat". Matti Hamalainen <ccr@tnsp.org> parents: diff changeset	127 #endif

Mercurial > hg > nnchat

annotate libnnchat.h @ 168:2e4850ece456