psock.h File Reference

Socket related utility functions with per-platform implementations. More...

#include "std.h"
#include "swdevice.h"

Functions
int32	PKSocketInit (int32 *pError)
	Performs any platform-specific initialization required to use sockets. More...
int32	PKSocketFinalize (int32 *pError)
	Performs any platform-specific finalization required to use sockets. More...
DEVICE_FILEDESCRIPTOR	PKOpenServerSocket (int32 port, int32 *pError)
	Opens a socket and sets it to listen for connections. More...
DEVICE_FILEDESCRIPTOR	PKOpenClientSocket (const uint8 *pbzAddr, int32 port, int32 *pError)
	Opens a socket connection using the specified address and port. More...
DEVICE_FILEDESCRIPTOR	PKAcceptConnection (DEVICE_FILEDESCRIPTOR descriptor, int32 *pError)
	Blocks waiting for an incoming connection. More...
int32	PKReadSocket (DEVICE_FILEDESCRIPTOR descriptor, uint8 *buff, int32 len, int32 *pError)
	Reads data from a socket. More...
int32	PKWriteSocket (DEVICE_FILEDESCRIPTOR descriptor, uint8 *buff, int32 len, int32 *pError)
	Writes data to a socket. More...
int32	PKCloseSocket (DEVICE_FILEDESCRIPTOR descriptor, int32 *pError)
	Closes a socket. More...

Detailed Description

Socket related utility functions with per-platform implementations.

Function Documentation

PKAcceptConnection()

DEVICE_FILEDESCRIPTOR PKAcceptConnection	(	DEVICE_FILEDESCRIPTOR	descriptor,
		int32 *	pError
	)

Blocks waiting for an incoming connection.

Parameters

[in]	descriptor	Socket descriptor, as returned by PKOpenSocket()
[out]	pError	Set to an error code if operations fails

Returns

non-negative socket descriptor for connection on success, -1 on failure

PKCloseSocket()

int32 PKCloseSocket	(	DEVICE_FILEDESCRIPTOR	descriptor,
		int32 *	pError
	)

Closes a socket.

Parameters

[in]	descriptor	Socket descriptor, as returned by PKAcceptConnection()
[out]	pError	Set to an error code if operations fails

Returns

0 on success, -1 on failure

PKOpenClientSocket()

DEVICE_FILEDESCRIPTOR PKOpenClientSocket	(	const uint8 *	pbzAddr,
		int32	port,
		int32 *	pError
	)

Opens a socket connection using the specified address and port.

Parameters

[in]	pbzAddr	The IP address to use when connecting.
[in]	port	Port number
[out]	pError	Set to an error code if operations fails

Returns

non-negative socket descriptor on success, -1 on failure

PKOpenServerSocket()

DEVICE_FILEDESCRIPTOR PKOpenServerSocket	(	int32	port,
		int32 *	pError
	)

Opens a socket and sets it to listen for connections.

Once a connection is established use PKAcceptConnection() to accept it.

Parameters

[in]	port	Port number
[out]	pError	Set to an error code if operations fails

Returns

non-negative socket descriptor on success, -1 on failure

PKReadSocket()

int32 PKReadSocket	(	DEVICE_FILEDESCRIPTOR	descriptor,
		uint8 *	buff,
		int32	len,
		int32 *	pError
	)

Reads data from a socket.

Parameters

[in]	descriptor	Socket descriptor, as returned by PKAcceptConnection()
[in]	buff	Buffer to read data into
[in]	len	Size of buff
[out]	pError	Set to an error code if operations fails

Returns

number of bytes read, -1 on failure

PKSocketFinalize()

int32 PKSocketFinalize

(

int32 *

pError

)

Performs any platform-specific finalization required to use sockets.

Parameters

[out]

pError

Set to an error code if operations fails

Returns

0 on success, -1 on failure

PKSocketInit()

int32 PKSocketInit

(

int32 *

pError

)

Performs any platform-specific initialization required to use sockets.

Parameters

[out]

pError

Set to an error code if operations fails

Returns

0 on success, -1 on failure

PKWriteSocket()

int32 PKWriteSocket	(	DEVICE_FILEDESCRIPTOR	descriptor,
		uint8 *	buff,
		int32	len,
		int32 *	pError
	)

Writes data to a socket.

Parameters

[in]	descriptor	Socket descriptor, as returned by PKAcceptConnection()
[in]	buff	Buffer of data to write
[in]	len	Size of buff
[out]	pError	Set to an error code if operations fails

Returns

number of bytes written, -1 on failure