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
|
/*
* Modification History
*
* 2001-January-10 Jason Rohrer
* Created.
*
* 2002-October-13 Jason Rohrer
* Added support for timeout on connect.
*
* 2008-September-30 Jason Rohrer
* Added support for non-blocking connect.
*
* 2009-December-23 Jason Rohrer
* Added note about manditory outTimedOut flag.
*/
#include "minorGems/common.h"
#ifndef SOCKET_CLIENT_CLASS_INCLUDED
#define SOCKET_CLIENT_CLASS_INCLUDED
#include "Socket.h"
#include "HostAddress.h"
#include <stdlib.h>
/**
* Class that can make connections to socket servers.
*
* Note: Implementation for the functions defined here is provided
* separately for each platform (in the mac/ linux/ and win32/
* subdirectories).
*
* @author Jason Rohrer
*/
class SocketClient {
public:
/**
* Connects to a server and returns a socket.
*
* NOTE:
* If inAddress is not in numerical format (in other words, if it
* requires a DNS lookup before connection), this function may block
* even if non-blocking mode is specified.
* Consider using LookupThread to lookup the address before
* calling this function.
*
* @param inAddress the host to connect to. Must be destroyed
* by caller.
* @param inTimeoutInMilliseconds the timeout value for the connect
* in milliseconds, or -1 for no timeout. Defaults to -1.
* Set to 0 for non-blocking connect that returns a not-yet-connected
* socket.
* @param outTimedOut pointer to where the timeout flag should
* be returned, or NULL for no timeout. If timeout used, will
* be set to true if timeout happened, or false if it did not.
* Defaults to NULL.
* MUST pass a pointer here if you want to use time-outs or
* non-blocking connects.
*
* @return a socket for the connection, or NULL if an error occurs.
*/
static Socket *connectToServer( HostAddress *inAddress,
long inTimeoutInMilliseconds = -1,
char *outTimedOut = NULL );
};
#endif
|
