author | Medo <smaxein@googlemail.com> |
Mon, 04 Jun 2012 21:12:20 +0200 | |
changeset 7173 | 7c2eb284f9f1 |
parent 7171 | 906e72caea7b |
child 7175 | 038e3415100a |
permissions | -rw-r--r-- |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
1 |
/* |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
2 |
* Low-level protocol support for the IPC connection to the engine. |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
3 |
*/ |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
4 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
5 |
#ifndef IPCCONN_H_ |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
6 |
#define IPCCONN_H_ |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
7 |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
8 |
#include "buffer.h" |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
9 |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
10 |
#include <stddef.h> |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
11 |
#include <stdbool.h> |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
12 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
13 |
typedef enum {IPC_NOT_CONNECTED, IPC_LISTENING, IPC_CONNECTED} IpcConnState; |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
14 |
|
7171 | 15 |
struct _flib_ipcconn; |
16 |
typedef struct _flib_ipcconn *flib_ipcconn; |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
17 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
18 |
/** |
7171 | 19 |
* Start an engine connection by listening on a random port. The selected port can |
20 |
* be queried with flib_ipcconn_port and has to be passed to the engine. |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
21 |
* |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
22 |
* The parameter "recordDemo" can be used to control whether demo recording should |
7171 | 23 |
* be enabled for this connection. The localPlayerName is needed for demo |
24 |
* recording purposes. |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
25 |
* |
7171 | 26 |
* Returns NULL on error. Destroy the created object with flib_ipcconn_destroy. |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
27 |
* |
7171 | 28 |
* We stop accepting new connections once a connection has been established, so you |
29 |
* need to create a new ipcconn in order to start a new connection. |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
30 |
*/ |
7171 | 31 |
flib_ipcconn flib_ipcconn_create(bool recordDemo, const char *localPlayerName); |
32 |
||
33 |
uint16_t flib_ipcconn_port(flib_ipcconn ipc); |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
34 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
35 |
/** |
7171 | 36 |
* Free resources, close sockets, and set the pointer to NULL. |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
37 |
*/ |
7171 | 38 |
void flib_ipcconn_destroy(flib_ipcconn *ipcptr); |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
39 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
40 |
/** |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
41 |
* Determine the current connection state |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
42 |
*/ |
7171 | 43 |
IpcConnState flib_ipcconn_state(flib_ipcconn ipc); |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
44 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
45 |
/** |
7173
7c2eb284f9f1
Frontlib: Work on the callback mechanisms for IPC
Medo <smaxein@googlemail.com>
parents:
7171
diff
changeset
|
46 |
* Receive a single message (up to 256 bytes) and copy it into the data buffer. |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
47 |
* Returns the length of the received message, a negative value if no message could |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
48 |
* be read. |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
49 |
* |
7173
7c2eb284f9f1
Frontlib: Work on the callback mechanisms for IPC
Medo <smaxein@googlemail.com>
parents:
7171
diff
changeset
|
50 |
* The first byte of a message is its content length, which is one less than the returned |
7c2eb284f9f1
Frontlib: Work on the callback mechanisms for IPC
Medo <smaxein@googlemail.com>
parents:
7171
diff
changeset
|
51 |
* value. |
7c2eb284f9f1
Frontlib: Work on the callback mechanisms for IPC
Medo <smaxein@googlemail.com>
parents:
7171
diff
changeset
|
52 |
* |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
53 |
* Note: When a connection is closed, you probably want to call this function until |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
54 |
* no further message is returned, to ensure you see all messages that were sent |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
55 |
* before the connection closed. |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
56 |
*/ |
7171 | 57 |
int flib_ipcconn_recv_message(flib_ipcconn ipc, void *data); |
58 |
||
59 |
int flib_ipcconn_send_raw(flib_ipcconn ipc, void *data, size_t len); |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
60 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
61 |
/** |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
62 |
* Write a single message (up to 255 bytes) to the engine. This call blocks until the |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
63 |
* message is completely written or the connection is closed or an error occurs. |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
64 |
* |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
65 |
* Calling this function in a state other than IPC_CONNECTED will fail immediately. |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
66 |
* Returns a negative value on failure. |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
67 |
*/ |
7171 | 68 |
int flib_ipcconn_send_message(flib_ipcconn ipc, void *data, size_t len); |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
69 |
|
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
70 |
/** |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
71 |
* Convenience function for sending a 0-delimited string. |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
72 |
*/ |
7171 | 73 |
int flib_ipcconn_send_messagestr(flib_ipcconn ipc, char *data); |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
74 |
|
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
75 |
/** |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
76 |
* Call regularly to allow background work to proceed |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
77 |
*/ |
7171 | 78 |
void flib_ipcconn_tick(flib_ipcconn ipc); |
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
79 |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
80 |
/** |
7171 | 81 |
* Get a demo record of the connection. This should be called after |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
82 |
* the connection is closed and all messages have been received. |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
83 |
* |
7171 | 84 |
* If demo recording was not enabled, or if the recording failed for some reason, |
85 |
* the buffer will be empty. |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
86 |
* |
7171 | 87 |
* The buffer is only valid until a call to flib_ipcconn_getsave(), since save |
88 |
* and demo records have some minor differences, and those are performed directly |
|
89 |
* on the buffer before returning it). |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
90 |
*/ |
7171 | 91 |
flib_constbuffer flib_ipcconn_getdemo(flib_ipcconn ipc); |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
92 |
|
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
93 |
/** |
7171 | 94 |
* Get a savegame record of the connection. This should be called after |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
95 |
* the connection is closed and all messages have been received. |
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
96 |
* |
7171 | 97 |
* If demo recording was not enabled, or if the recording failed for some reason, |
98 |
* the buffer will be empty. |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
99 |
* |
7171 | 100 |
* The buffer is only valid until a call to flib_ipcconn_getdemo(), since save |
101 |
* and demo records have some minor differences, and those are performed directly |
|
102 |
* on the buffer before returning it). |
|
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
103 |
*/ |
7171 | 104 |
flib_constbuffer flib_ipcconn_getsave(flib_ipcconn ipc); |
7162
fe76d24a25d7
Demo recording for the frontend library
Medo <smaxein@googlemail.com>
parents:
7160
diff
changeset
|
105 |
|
7158
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
106 |
#endif /* IPCCONN_H_ */ |
a0573014ff4f
Further work on the frontend library, restructuring, ...
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
107 |