Net/Wifi Library


Defines

#define PGE_SOCKET_TCP   SOCK_STREAM
#define PGE_SOCKET_UDP   SOCK_DGRAM
#define PGE_LOCAL_IP   0
#define PGE_REAL_IP   1
#define PGE_MAX_CLIENTS   256

Typedefs

typedef int pgeSocket
typedef fd_set pgeSocketSet

Functions

int pgeNetInit (void)
int pgeNetShutdown (void)
int pgeNetGetFile (const char *url, const char *filepath)
int pgeNetPostForm (const char *url, char *data, char *response, unsigned int responsesize)
int pgeNetSwitchStatus (void)
void pgeNetDisconnect (void)
int pgeNetIsConnected (void)
int pgeNetGetLocalIp (char *buffer)
int pgeNetResolveHost (char *hostname, char *resolved)
pgeSocket pgeNetSocketCreate (void)
pgeSocket pgeNetSocketAccept (pgeSocket socket)
int pgeNetSocketBind (pgeSocket socket, unsigned short port)
int pgeNetSocketListen (pgeSocket socket, unsigned int maxconn)
int pgeNetSocketConnect (pgeSocket socket, char *ip, unsigned short port)
int pgeNetSocketSend (pgeSocket socket, const void *data, int length)
int pgeNetSocketReceive (pgeSocket socket, void *data, int length)
void pgeNetSocketClose (pgeSocket socket)
void pgeNetSocketSetClear (pgeSocketSet *set)
void pgeNetSocketSetAdd (pgeSocket socket, pgeSocketSet *set)
void pgeNetSocketSetRemove (pgeSocket socket, pgeSocketSet *set)
int pgeNetSocketSetIsMember (pgeSocket socket, pgeSocketSet *set)
int pgeNetSocketSetSelect (unsigned int maxsockets, pgeSocketSet *set)

Define Documentation

#define PGE_LOCAL_IP   0

Local IP ie. 192.168.x.x

#define PGE_MAX_CLIENTS   256

Maximum clients that can connect to a server

#define PGE_REAL_IP   1

'Real' IP

#define PGE_SOCKET_TCP   SOCK_STREAM

Stream socket

#define PGE_SOCKET_UDP   SOCK_DGRAM

Datagram socket


Typedef Documentation

typedef int pgeSocket

typedef fd_set pgeSocketSet


Function Documentation

void pgeNetDisconnect ( void   ) 

Disconnect from an access point

int pgeNetGetFile ( const char *  url,
const char *  filepath 
)

Download a file

Parameters:
url - The URL of the file
filepath - The path to save the downloaded file
Returns:
1 on success else an error code.

int pgeNetGetLocalIp ( char *  buffer  ) 

Get Local IP address

Parameters:
buffer - Pointer to a buffer which will store the IP address
Returns:
1 on success else an error code.

int pgeNetInit ( void   ) 

Initialise the wifi

Returns:
1 on success else an error code.

int pgeNetIsConnected ( void   ) 

Check if connected to an access point

Returns:
1 on valid connection

int pgeNetPostForm ( const char *  url,
char *  data,
char *  response,
unsigned int  responsesize 
)

Post a form

Parameters:
url - The URL to post to
data - The data to post
response - The buffer where the response from the server will be stored
responsesize - Size of the response buffer
Returns:
1 on success else an error code.

int pgeNetResolveHost ( char *  hostname,
char *  resolved 
)

Resolve a hostname

Parameters:
hostname - The hostname to resolve
resolved - Pointer to a buffer that will store the resolved hostname
Returns:
1 on success else an error code.

int pgeNetShutdown ( void   ) 

Shutdown the wifi

Returns:
1 on success else an error code.

pgeSocket pgeNetSocketAccept ( pgeSocket  socket  ) 

Accept a connection

Parameters:
socket - The socket.
Returns:
A pgeSocket for the incoming connection.

int pgeNetSocketBind ( pgeSocket  socket,
unsigned short  port 
)

Bind a socket to a port

Parameters:
socket - The socket.
port - The port to bind to.
Returns:
1 on success, 0 on error.

void pgeNetSocketClose ( pgeSocket  socket  ) 

Close a socket

Parameters:
socket - The socket.

int pgeNetSocketConnect ( pgeSocket  socket,
char *  ip,
unsigned short  port 
)

Connect to an IP and port

Parameters:
socket - The socket.
ip - The IP to connect to.
port - The port to connect to.
Returns:
1 on success, 0 on error.

pgeSocket pgeNetSocketCreate ( void   ) 

Create a socket

Returns:
A pgeSocket.

int pgeNetSocketListen ( pgeSocket  socket,
unsigned int  maxconn 
)

Listen for connections

Parameters:
socket - The socket.
maxconn - The maximum amount of connections to listen for.
Returns:
1 on success, 0 on error.

int pgeNetSocketReceive ( pgeSocket  socket,
void *  data,
int  length 
)

Receive data

Parameters:
socket - The socket.
data - Pointer to a buffer where the received data will be stored.
length - The size of the buffer (in bytes).
Returns:
Number of bytes received, -1 on error.

int pgeNetSocketSend ( pgeSocket  socket,
const void *  data,
int  length 
)

Send data

Parameters:
socket - The socket.
data - The data to send.
length - The size of the data (in bytes).
Returns:
Number of bytes sent, -1 on error.

void pgeNetSocketSetAdd ( pgeSocket  socket,
pgeSocketSet set 
)

Add a socket to a socket set

Parameters:
socket - The socket to add.
set - The socket set to add the socket to.

void pgeNetSocketSetClear ( pgeSocketSet set  ) 

Clear a socket set

Parameters:
set - The socket set to clear.

int pgeNetSocketSetIsMember ( pgeSocket  socket,
pgeSocketSet set 
)

Check if a socket is a member of a socket set

Parameters:
socket - The socket to check.
set - The socket set to check the socket is a member of.
Returns:
1 if the socket is a member of the set, otherwise 0.

void pgeNetSocketSetRemove ( pgeSocket  socket,
pgeSocketSet set 
)

Remove a socket from a socket set

Parameters:
socket - The socket to remove.
set - The socket set to remove the socket from.

int pgeNetSocketSetSelect ( unsigned int  maxsockets,
pgeSocketSet set 
)

Check if a socket is ready for reading

Parameters:
maxsockets - Maximum number of sockets to check.
set - The socket set to check.
Returns:
Number of sockets, -1 on error.

int pgeNetSwitchStatus ( void   ) 

Get the status of the wlan switch

Returns:
1 if switch is up


Generated on Mon Sep 22 16:58:14 2008 for Phoenix Game Engine by  doxygen 1.5.5