Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added GSocket_Select() and removed some unused functions

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3614 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Guillermo Rodriguez Garcia
1999-09-11 20:29:14 +00:00
parent 56d8adc0c0
commit e9e3e3abaf
1 changed files with 85 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
include/wx/gsocket.h
View File

@@ -27,6 +27,11 @@ typedef int bool;
#define FALSE 0 #define FALSE 0
#endif #endif
#ifdef __cplusplus
extern "C" {
#endif
typedef struct _GSocket GSocket; typedef struct _GSocket GSocket;
typedef struct _GAddress GAddress; typedef struct _GAddress GAddress;
@@ -75,11 +80,8 @@ typedef int GSocketEventFlags;
typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event, typedef void (*GSocketCallback)(GSocket *socket, GSocketEvent event,
char *cdata); char *cdata);
#ifdef __cplusplus
extern "C" {
#endif
/* Global initialisers */ /* Global initializers */
/* GSocket_Init() must be called at the beginning */ /* GSocket_Init() must be called at the beginning */
bool GSocket_Init(); bool GSocket_Init();
@@ -91,7 +93,7 @@ void GSocket_Cleanup();
GSocket *GSocket_new(); GSocket *GSocket_new();
void GSocket_destroy(GSocket *socket); void GSocket_destroy(GSocket *socket);
/* This will disable all IO calls to this socket but errors are still available */ /* This will disable all further IO calls to this socket */
void GSocket_Shutdown(GSocket *socket); void GSocket_Shutdown(GSocket *socket);
/* Address handling */ /* Address handling */
@@ -107,88 +109,107 @@ GSocketError GSocket_SetNonOriented(GSocket *socket);
/* Server specific parts */ /* Server specific parts */
/* /* GSocket_SetServer:
GSocket_SetServer() setups the socket as a server. It uses the "Local" field * Sets up the socket as a server. It uses the "Local" field of GSocket.
of GSocket. "Local" must be set by GSocket_SetLocal() before * "Local" must be set by GSocket_SetLocal() before GSocket_SetServer()
GSocket_SetServer() is called. In the other case, it returns GSOCK_INVADDR. * is called. Possible error codes are: GSOCK_INVSOCK if socket has not
* been initialized, GSOCK_INVADDR if the local address has not been
* defined and GSOCK_IOERR for other internal errors.
*/ */
GSocketError GSocket_SetServer(GSocket *socket); GSocketError GSocket_SetServer(GSocket *socket);
/* /* GSocket_WaitConnection:
GSocket_WaitConnection() waits for an incoming client connection. * Waits for an incoming client connection.
*/ */
GSocket *GSocket_WaitConnection(GSocket *socket); GSocket *GSocket_WaitConnection(GSocket *socket);
/* Client specific parts */ /* Client specific parts */
/* /* GSocket_Connect:
GSocket_Connect() establishes a client connection to a server using the "Peer" * Establishes a client connection to a server using the "Peer"
field of GSocket. "Peer" must be set by GSocket_SetPeer() before * field of GSocket. "Peer" must be set by GSocket_SetPeer() before
GSocket_Connect() is called. In the other case, it returns GSOCK_INVADDR. * GSocket_Connect() is called. Possible error codes are GSOCK_INVSOCK,
* GSOCK_INVADDR, GSOCK_TIMEDOUT, GSOCK_WOULDBLOCK and GSOCK_IOERR.
* If a socket is nonblocking and Connect() returns GSOCK_WOULDBLOCK,
* the connection request can be completed later. Use GSocket_Select()
* to check it, or wait for a GSOCK_CONNECTION event.
*/ */
GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream); GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream);
/* Generic IO */ /* Generic IO */
/* Like recv(), send(), ... */ /* Like recv(), send(), ... */
/*
NOTE: In case we read from a non-oriented connection, the incoming (outgoing) /* NOTE: In case we read from a non-oriented connection, the incoming
connection address is stored in the "Local" ("Peer") field. * (outgoing) connection address is stored in the "Local" ("Peer")
* field.
*/ */
int GSocket_Read(GSocket *socket, char *buffer, int size); int GSocket_Read(GSocket *socket, char *buffer, int size);
int GSocket_Write(GSocket *socket, const char *buffer, int GSocket_Write(GSocket *socket, const char *buffer,
int size); int size);
bool GSocket_DataAvailable(GSocket *socket);
/* GSocket_Select:
* Polls the socket to determine its status. This function will
* check for the events specified in the 'flags' parameter, and
* it will return a mask indicating which operations can be
* performed. This function won't block, regardless of the
* mode (blocking|nonblocking) of the socket.
*/
GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags);
/* Flags/Parameters */ /* Flags/Parameters */
/* /* GSocket_SetTimeout:
GSocket_SetTimeout() sets the timeout for reading and writing IO call. Time * Sets the timeout for blocking calls. Time is
is expressed in milliseconds. * expressed in milliseconds.
*/ */
void GSocket_SetTimeout(GSocket *socket, unsigned long millisec); void GSocket_SetTimeout(GSocket *socket, unsigned long millisec);
/* /* GSocket_SetNonBlocking:
GSocket_SetBlocking() puts the socket in non-blocking mode. This is useful * Sets the socket to non-blocking mode. This is useful if
if we don't want to wait. * we don't want to wait.
*/ */
void GSocket_SetNonBlocking(GSocket *socket, bool non_block); void GSocket_SetNonBlocking(GSocket *socket, bool non_block);
/* /* GSocket_GetError:
GSocket_GetError() returns the last error occured on the socket stream. * Returns the last error occured for this socket.
*/ */
GSocketError GSocket_GetError(GSocket *socket); GSocketError GSocket_GetError(GSocket *socket);
/* Callbacks */ /* Callbacks */
/* /* Only one callback is possible for each event (INPUT, OUTPUT, CONNECTION
Only one fallback is possible for each event (INPUT, OUTPUT, CONNECTION, LOST) * and LOST). The callbacks are called in the following situations:
INPUT: The function is called when there is at least a byte in the *
input buffer * INPUT: There is at least one byte in the input buffer
OUTPUT: The function is called when the system is sure the next write call * OUTPUT: The system is sure that the next write call will not block
will not block * CONNECTION: Two cases are possible:
CONNECTION: Two cases is possible: * Client socket -> the connection is established
Client socket -> the connection is established * Server socket -> a client requests a connection
Server socket -> a client request a connection * LOST: The connection is lost
LOST: the connection is lost *
* An event is generated only once and its state is reseted when the
SetCallback accepts a combination of these flags so a same callback can * relative IO call is requested.
receive different events. * For example: INPUT -> GSocket_Read()
* CONNECTION -> GSocket_Accept()
An event is generated only once and its state is reseted when the relative
IO call is requested.
For example: INPUT -> GSocket_Read()
CONNECTION -> GSocket_Accept()
*/ */
void GSocket_SetCallback(GSocket *socket, GSocketEventFlags event,
/* GSocket_SetCallback:
* Enables the callbacks specified by 'flags'. Note that 'flags'
* may be a combination of flags OR'ed toghether, so the same
* callback function can be made to accept different events.
* The callback function must have the following prototype:
*
* void function(GSocket *socket, GSocketEvent event, char *cdata)
*/
void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
GSocketCallback fallback, char *cdata); GSocketCallback fallback, char *cdata);
/* /* GSocket_UnsetCallback:
UnsetCallback will disables all fallbacks specified by "event". * Disables all callbacks specified by 'flags', which may be a
NOTE: event may be a combination of flags * combination of flags OR'ed toghether.
*/ */
void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags event); void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags);
/* GAddress */ /* GAddress */
@@ -199,10 +220,9 @@ void GAddress_destroy(GAddress *address);
void GAddress_SetFamily(GAddress *address, GAddressType type); void GAddress_SetFamily(GAddress *address, GAddressType type);
GAddressType GAddress_GetFamily(GAddress *address); GAddressType GAddress_GetFamily(GAddress *address);
/* /* The use of any of the next functions will set the address family to
The use of any of the next functions will set the address family to the adapted * the specific one. For example if you use GAddress_INET_SetHostName,
one. For example if you use GAddress_INET_SetHostName, address family will be AF_INET * address family will be implicitly set to AF_INET.
implicitely
*/ */
GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname); GSocketError GAddress_INET_SetHostName(GAddress *address, const char *hostname);
@@ -222,23 +242,11 @@ unsigned short GAddress_INET_GetPort(GAddress *address);
GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path); GSocketError GAddress_UNIX_SetPath(GAddress *address, const char *path);
GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf); GSocketError GAddress_UNIX_GetPath(GAddress *address, char *path, size_t sbuf);
/*
* System specific functions
*/
/* On systems needing an event id */
void GSocket_SetEventID(GSocket *socket, unsigned long evt_id);
/* On systems which don't have background refresh */
void GSocket_DoEvent(unsigned long evt_id);
#ifdef __cplusplus #ifdef __cplusplus
}; };
#endif /* __cplusplus */ #endif /* __cplusplus */
#endif #endif /* wxUSE_SOCKETS */
/* wxUSE_SOCKETS */
#endif #endif /* __GSOCKET_H */
/* __GSOCKET_H */