summaryrefslogtreecommitdiffstats
path: root/server.h
blob: b3812f29e257c235d1930db5254c3ab55695b3bf (plain)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/******************************************************************************
  Copyright (c) 1992, 1995, 1996 Xerox Corporation.  All rights reserved.
  Portions of this code were written by Stephen White, aka ghond.
  Use and copying of this software and preparation of derivative works based
  upon this software are permitted.  Any distribution of this software or
  derivative works must comply with all applicable United States export
  control laws.  This software is made available AS IS, and Xerox Corporation
  makes no warranty about the software, its performance or its conformity to
  any specification.  Any person obtaining a copy of this software is requested
  to send their name and post office or electronic mail address to:
    Pavel Curtis
    Xerox PARC
    3333 Coyote Hill Rd.
    Palo Alto, CA 94304
    Pavel@Xerox.Com
 *****************************************************************************/

/* server.h */

/*
 * This describes the complete set of procedures that a network implementation
 * is expected to use from the rest of the server.  See 'network.h' for the
 * complete set of procedures that a network implementation must provide.
 */

#ifndef Server_H
#define Server_H 1

#include "my-stdio.h"

#include "config.h"

typedef struct {		/* Server's handle on a connection */
    void *ptr;
} server_handle;

typedef struct {		/* Server's handle on a listening point */
    void *ptr;
} server_listener;

#include "network.h"		/* Include this *after* defining the types */

extern server_listener null_server_listener;

extern server_handle server_new_connection(server_listener l,
					 network_handle h, int outbound);
				/* Called by the network whenever a new player
				 * connection is created.  If `outbound' is
				 * true, then the connection is being made from
				 * the server to some external place, and L is
				 * NULL_SERVER_LISTENER; if `outbound' is
				 * false, the L is the listening point on which
				 * the new connection was received.  By this
				 * call, the network and server exchange tokens
				 * representing the connection for use in later
				 * calls on each other.
				 */

extern void server_refuse_connection(server_listener l,
				     network_handle h);
				/* Called by the network whenever it has
				 * temporarily accepted a connection just to
				 * explain to the user that the server is too
				 * full to accept their connection for real.
				 * The server may call network_send_line() and
				 * network_connection_name() to print the
				 * explanation, but H will no longer be valid
				 * after server_refuse_connection() returns.
				 */

extern void server_receive_line(server_handle h, const char *line);
				/* The given line has been received as input
				 * on the specified connection.  'line' does
				 * not end in a newline; any such bytes have
				 * been removed by the network.  The characters
				 * in 'line' are all either spaces or non-
				 * whitespace ASCII characters.
				 */

extern void server_close(server_handle h);
				/* The specified connection has been broken
				 * for some reason not in the server's control.
				 * Effective immediately, the network will no
				 * longer use the given server_handle and the
				 * server should not use the corresponding
				 * network_handle.
				 */

/*
 * The following procedures should not be called by a network implementation;
 * they are exported from the server module to other parts of the program.
 */

extern void server_suspend_input(Objid connection);
				/* As soon as possible, the server module
				 * should temporarily stop enqueuing input
				 * tasks for the given connection.
				 */
extern void server_resume_input(Objid connection);
				/* The server module may resume enqueuing input
				 * tasks for the given connection.
				 */

extern void set_server_cmdline(const char *line);
				/* If possible, the server's command line, as
				 * shown in the output of the `ps' command, is
				 * changed to the given string.  NOTE: This is
				 * not possible on all systems, so this
				 * operation is effectively a no-op in some
				 * cases.
				 */

#include "structures.h"

extern int server_flag_option(const char *name);
				/* Return true iff both $server_options and
				 * $server_options.NAME exist and the latter
				 * has a true MOO value.
				 */

extern int server_int_option(const char *name, int defallt);
				/* If both $server_options and
				 * $server_options.NAME exist and the latter
				 * has a numeric value, then return that value.
				 * Otherwise, return DEFALLT.
				 */

extern const char *server_string_option(const char *name,
					const char *defallt);
				/* If either $server_options or
				 * $server_options.NAME does not exist, then
				 * return DEFALLT.  Otherwise, if the latter
				 * has a string value, then return that value;
				 * else, return 0.  NOTE that the returned
				 * string has not had its reference count
				 * changed; the caller should str_ref() the
				 * result if the reference is to be persistent.
				 */

extern int get_server_option(Objid oid, const char *name, Var * r);
				/* If OID.server_options or $server_options
				 * exists, and the first of these that exists
				 * has as value a valid object OPT, and
				 * OPT.NAME exists, then set *R to the value of
				 * OPT.NAME and return 1; else return 0.
				 */

enum Fork_Result {
    FORK_PARENT, FORK_CHILD, FORK_ERROR
};
extern enum Fork_Result fork_server(const char *subtask_name);

extern void player_connected(Objid old_id, Objid new_id,
			     int is_newly_created);
extern void notify(Objid player, const char *message);
extern void boot_player(Objid player);

extern void write_active_connections(void);
extern int read_active_connections(void);



/* Body for *_connection_option() */
#define CONNECTION_OPTION_GET(TABLE,HANDLE,OPTION,VALUE)	\
    _STATEMENT({						\
	TABLE(_CONNECT_OPTION_GET_SINGLE, (HANDLE), @,		\
	      _RMPAREN2((OPTION),(VALUE)))			\
	return 0;						\
    })

/* Body for *_set_connection_option() */
#define CONNECTION_OPTION_SET(TABLE,HANDLE,OPTION,VALUE)	\
    _STATEMENT({						\
	TABLE(_CONNECT_OPTION_SET_SINGLE, (HANDLE), (VALUE),	\
	      _RMPAREN2((OPTION),(VALUE)))			\
	return 0;						\
    })

/* Body for *_connection_options() */
#define CONNECTION_OPTION_LIST(TABLE,HANDLE,LIST)	\
    _STATEMENT({					\
	TABLE(_CONNECT_OPTION_LIST_SINGLE, (HANDLE), @,	\
	      (LIST))					\
	return (LIST);					\
    })

/* All of the above require a TABLE of connection options #defined
 * as follows
 * 
 * #define TABLE(DEFINE, HANDLE, VALUE, _)
 *    DEFINE(<name>, _, TYPE_<foo>, <member>,
 *           <get-value-expression>,
 *           <set-value-statement>)
 *    ...
 *    
 * where
 *   <get-value-expression>
 *     should extract from HANDLE a value for option <name>
 *     of type suitable for assignment to Var.v.<member>
 *   <set-value-expression>
 *     should do whatever needs to be done to HANDLE
 *     to reflect the new VALUE
 */

/*
 * Helper macros for CONNECTION_OPTION_(GET|SET|LIST)
 * (nothing should need to invoke these directly):
 */
#define _RMPAREN2(ARG1,ARG2) ARG1,ARG2
#define _STATEMENT(STMT) do STMT while (0)

#define _CONNECT_OPTION_GET_SINGLE(NAME, OPTION, VALUE,		\
				   TYPE_FOO, VFOO_MEMBER,	\
				   GETVALUE, SETVALUE)		\
    if (!mystrcasecmp(OPTION, #NAME)) {				\
	VALUE->type  = (TYPE_FOO);				\
	VALUE->v.VFOO_MEMBER = (GETVALUE);			\
	return 1;						\
    }

#define _CONNECT_OPTION_SET_SINGLE(NAME, OPTION, VALUE,		\
				   TYPE_FOO, VFOO_MEMBER,	\
				   GETVALUE, SETVALUE)		\
    if (!mystrcasecmp(OPTION, #NAME)) {				\
	SETVALUE;						\
	return 1;						\
    }

#define _CONNECT_OPTION_LIST_SINGLE(NAME, LIST,			\
				    TYPE_FOO, VFOO_MEMBER,	\
				    GETVALUE, SETVALUE)		\
    {								\
	Var pair = new_list(2);					\
	pair.v.list[1].type = TYPE_STR;				\
	pair.v.list[1].v.str = str_dup(#NAME);			\
	pair.v.list[2].type = (TYPE_FOO);			\
	pair.v.list[2].v.VFOO_MEMBER = (GETVALUE);		\
	LIST = listappend(LIST, pair);				\
    }								\


#endif				/* Server_H */

/* 
 * $Log$
 * Revision 1.4  2004/05/22 01:25:44  wrog
 * merging in WROGUE changes (W_SRCIP, W_STARTUP, W_OOB)
 *
 * Revision 1.3.10.1  2003/06/07 12:59:04  wrog
 * introduced connection_option macros
 *
 * Revision 1.3  1998/12/14 13:18:58  nop
 * Merge UNSAFE_OPTS (ref fixups); fix Log tag placement to fit CVS whims
 *
 * Revision 1.2  1997/03/03 04:19:26  nop
 * GNU Indent normalization
 *
 * Revision 1.1.1.1  1997/03/03 03:45:04  nop
 * LambdaMOO 1.8.0p5
 *
 * Revision 2.3  1996/04/08  01:07:52  pavel
 * Made get_server_option() public.  Release 1.8.0p3.
 *
 * Revision 2.2  1996/02/08  06:13:19  pavel
 * Updated copyright notice for 1996.  Release 1.8.0beta1.
 *
 * Revision 2.1  1995/12/31  03:22:30  pavel
 * Added support for multiple listening points.  Added entry point for dealing
 * with the server-full condition.  Release 1.8.0alpha4.
 *
 * Revision 2.0  1995/11/30  04:54:57  pavel
 * New baseline version, corresponding to release 1.8.0alpha1.
 *
 * Revision 1.4  1992/10/23  23:03:47  pavel
 * Added copyright notice.
 *
 * Revision 1.3  1992/10/21  03:02:35  pavel
 * Converted to use new automatic configuration system.
 *
 * Revision 1.2  1992/09/08  22:05:35  pjames
 * Removed procedures which are no longer exported.
 *
 * Revision 1.1  1992/07/20  23:23:12  pavel
 * Initial RCS-controlled version.
 */