stream-server.h File Reference

Network stream server functions. (TCP). More...

#include "nets/socket.h"

Typedefs
typedef struct StreamServer_T	StreamServer_T
typedef StreamServer_T *	StreamServer
typedef struct StreamSession_T	StreamSession_T
typedef StreamSession_T *	StreamSession
typedef void *(*	OnStreamSessionCreate) (StreamServer streamServer, StreamSession streamSession)
	Stream session create function. (TCP).
typedef void(*	OnStreamSessionDestroy) (StreamServer streamServer, StreamSession streamSession, int reason)
	Stream session destroy function. (TCP).
typedef int(*	OnStreamSessionReceive) (StreamServer streamServer, StreamSession streamSession, const uint8_t *receiveBuffer, size_t byteCount)
	Stream session data receive function. (TCP).
typedef void(*	OnStreamServerDatagram) (StreamServer streamServer, SocketAddress remoteAddress, const uint8_t *receiveBuffer, size_t byteCount)
	Stream server datagram receive function. (UDP).

Functions
NetsResult	createStreamServer (SocketFamily socketFamily, const char *service, size_t sessionBufferSize, size_t connectionQueueSize, size_t receiveBufferSize, double timeoutTime, OnStreamSessionCreate onCreate, OnStreamSessionDestroy onDestroy, OnStreamSessionReceive onReceive, OnStreamServerDatagram onDatagram, void *handle, SslContext sslContext, StreamServer *streamServer)
	Creates a new stream server instance. (TCP).
void	destroyStreamServer (StreamServer streamServer)
	Destroys stream server instance. (TCP).
size_t	getStreamServerSessionBufferSize (StreamServer streamServer)
	Returns stream server session buffer size.
size_t	getStreamServerReceiveBufferSize (StreamServer streamServer)
	Returns stream server receive buffer size in bytes.
OnStreamSessionCreate	getStreamServerOnCreate (StreamServer streamServer)
	Returns stream server session create function.
OnStreamSessionDestroy	getStreamServerOnDestroy (StreamServer streamServer)
	Returns stream server session destroy function.
OnStreamSessionReceive	getStreamServerOnReceive (StreamServer streamServer)
	Returns stream server session data receive function.
OnStreamServerDatagram	getStreamServerOnDatagram (StreamServer streamServer)
	Returns stream server datagram receive function.
double	getStreamServerTimeoutTime (StreamServer streamServer)
	Returns stream server session timeout time. (in seconds).
void *	getStreamServerHandle (StreamServer streamServer)
	Returns stream server handle.
uint8_t *	getStreamServerReceiveBuffer (StreamServer streamServer)
	Returns stream server receive data buffer.
Socket	getStreamServerSocket (StreamServer streamServer)
	Returns stream server socket instance.
Socket	getStreamServerDatagramSocket (StreamServer streamServer)
	Returns stream server datagram socket instance.
bool	isStreamServerRunning (StreamServer streamServer)
	Returns true if stream server receive thread is running. (MT-Safe).
bool	isStreamServerSecure (StreamServer streamServer)
	Returns true if stream server use encrypted connection.
void	lockStreamServerSessions (StreamServer streamServer)
	Locks stream server sessions access. (MT-Safe).
void	unlockStreamServerSessions (StreamServer streamServer)
	Unlocks stream server sessions access. (MT-Safe).
StreamSession *	getStreamServerSessions (StreamServer streamServer)
	Returns stream server session buffer.
size_t	getStreamServerSessionCount (StreamServer streamServer)
	Returns stream server session buffer.
Socket	getStreamSessionSocket (StreamSession streamSession)
	Returns stream session socket instance.
SocketAddress	getStreamSessionRemoteAddress (StreamSession streamSession)
	Returns stream session remote IP address instance.
void *	getStreamSessionHandle (StreamSession streamSession)
	Returns stream session handle.
int	updateStreamSession (StreamServer streamServer, StreamSession streamSession, double currentTime)
	Updates specified stream server session state.
void	destroyStreamSession (StreamServer streamServer, StreamSession streamSession, int reason)
	Destroyes specified stream server session.
void	flushStreamSessions (StreamServer streamServer)
	Flushes destroyed stream server sessions.
void	aliveStreamSession (StreamSession streamSession)
	Resets specified stream server session timeout time.
NetsResult	streamSessionSend (StreamSession streamSession, const void *data, size_t byteCount)
	Sends stream data to the specified session. (TCP).
NetsResult	streamServerSendDatagram (StreamServer streamServer, SocketAddress remoteAddress, const void *data, size_t byteCount)
	Sends datagram to the specified socket address. (UDP).
NetsResult	shutdownStreamSession (StreamSession streamSession, SocketShutdown shutdown)
	Shutdowns part of the full-duplex socket connection.

Detailed Description

Network stream server functions. (TCP).

Typedef Documentation

StreamServer_T

typedef struct StreamServer_T StreamServer_T

Stream server structure. (TCP)

StreamServer

typedef StreamServer_T* StreamServer

Stream server instance. (TCP)

StreamSession_T

typedef struct StreamSession_T StreamSession_T

Stream server session structure. (TCP)

StreamSession

typedef StreamSession_T* StreamSession

Stream server session instance. (TCP)

OnStreamSessionCreate

typedef void *(* OnStreamSessionCreate) (StreamServer streamServer, StreamSession streamSession)

Stream session create function. (TCP).

Warning

This function is called asynchronously from the receive thread!

Returns

Custom stream session handle on success, otherwise NULL.

Parameters

streamServer	stream server instance
streamSession	a new accepted stream session instance

OnStreamSessionDestroy

typedef void(* OnStreamSessionDestroy) (StreamServer streamServer, StreamSession streamSession, int reason)

Stream session destroy function. (TCP).

Note

This function is called synchronously.

Parameters

streamServer	stream server instance
streamSession	stream session instance
reason	session destruction reason

OnStreamSessionReceive

typedef int(* OnStreamSessionReceive) (StreamServer streamServer, StreamSession streamSession, const uint8_t *receiveBuffer, size_t byteCount)

Stream session data receive function. (TCP).

Server destroys session on this function non zero return result.

Warning

This function is called asynchronously from the receive thread!

Parameters

	streamServer	stream server instance
	streamSession	stream session instance
[in]	receiveBuffer	received data buffer
	byteCount	received byte count

OnStreamServerDatagram

typedef void(* OnStreamServerDatagram) (StreamServer streamServer, SocketAddress remoteAddress, const uint8_t *receiveBuffer, size_t byteCount)

Stream server datagram receive function. (UDP).

Warning

This function is called asynchronously from the receive thread!

Parameters

	streamServer	stream server instance
	remoteAddress	sender socket remote address
[in]	receiveBuffer	received data buffer
	byteCount	received byte count

Function Documentation

createStreamServer()

NetsResult createStreamServer	(	SocketFamily	socketFamily,
		const char *	service,
		size_t	sessionBufferSize,
		size_t	connectionQueueSize,
		size_t	receiveBufferSize,
		double	timeoutTime,
		OnStreamSessionCreate	onCreate,
		OnStreamSessionDestroy	onDestroy,
		OnStreamSessionReceive	onReceive,
		OnStreamServerDatagram	onDatagram,
		void *	handle,
		SslContext	sslContext,
		StreamServer *	streamServer )

Creates a new stream server instance. (TCP).

Returns

The operation NetsResult code.

Parameters

	socketFamily	local socket IP address family
[in]	service	local IP address service string (port)
	sessionBufferSize	session buffer size
	connectionQueueSize	pending connections queue size
	receiveBufferSize	receive data buffer size in bytes
	timeoutTime	session timeout time in seconds
[in]	onCreate	on session create function
[in]	onDestroy	on session destroy function
[in]	onReceive	on session data receive function
[in]	onDatagram	on datagram receive function or NULL
[in]	handle	receive function argument or NULL
	sslContext	socket SSL context instance or NULL
[out]	streamServer	pointer to the stream server instance

destroyStreamServer()

void destroyStreamServer

(

StreamServer

streamServer

)

Destroys stream server instance. (TCP).

Parameters

streamServer

target stream server instance or NULL

getStreamServerSessionBufferSize()

size_t getStreamServerSessionBufferSize

(

StreamServer

streamServer

)

Returns stream server session buffer size.

Parameters

streamServer

target stream server instance

getStreamServerReceiveBufferSize()

size_t getStreamServerReceiveBufferSize

(

StreamServer

streamServer

)

Returns stream server receive buffer size in bytes.

Parameters

streamServer

target stream server instance

getStreamServerOnCreate()

OnStreamSessionCreate getStreamServerOnCreate

(

StreamServer

streamServer

)

Returns stream server session create function.

Parameters

streamServer

target stream server instance

getStreamServerOnDestroy()

OnStreamSessionDestroy getStreamServerOnDestroy

(

StreamServer

streamServer

)

Returns stream server session destroy function.

Parameters

streamServer

target stream server instance

getStreamServerOnReceive()

OnStreamSessionReceive getStreamServerOnReceive

(

StreamServer

streamServer

)

Returns stream server session data receive function.

Parameters

streamServer

target stream server instance

getStreamServerOnDatagram()

OnStreamServerDatagram getStreamServerOnDatagram

(

StreamServer

streamServer

)

Returns stream server datagram receive function.

Parameters

streamServer

target stream server instance

getStreamServerTimeoutTime()

double getStreamServerTimeoutTime

(

StreamServer

streamServer

)

Returns stream server session timeout time. (in seconds).

Parameters

streamServer

target stream server instance

getStreamServerHandle()

void * getStreamServerHandle

(

StreamServer

streamServer

)

Returns stream server handle.

Parameters

streamServer

target stream server instance

getStreamServerReceiveBuffer()

uint8_t * getStreamServerReceiveBuffer

(

StreamServer

streamServer

)

Returns stream server receive data buffer.

Parameters

streamServer

target stream server instance

getStreamServerSocket()

Socket getStreamServerSocket

(

StreamServer

streamServer

)

Returns stream server socket instance.

Parameters

streamServer

target stream server instance

getStreamServerDatagramSocket()

Socket getStreamServerDatagramSocket

(

StreamServer

streamServer

)

Returns stream server datagram socket instance.

Parameters

streamServer

target stream server instance

isStreamServerRunning()

bool isStreamServerRunning

(

StreamServer

streamServer

)

Returns true if stream server receive thread is running. (MT-Safe).

Parameters

streamServer

target stream server instance

isStreamServerSecure()

bool isStreamServerSecure

(

StreamServer

streamServer

)

Returns true if stream server use encrypted connection.

Parameters

streamServer

target stream server instance

lockStreamServerSessions()

void lockStreamServerSessions

(

StreamServer

streamServer

)

Locks stream server sessions access. (MT-Safe).

Parameters

streamServer

target stream server instance

unlockStreamServerSessions()

void unlockStreamServerSessions

(

StreamServer

streamServer

)

Unlocks stream server sessions access. (MT-Safe).

Parameters

streamServer

target stream server instance

getStreamServerSessions()

StreamSession * getStreamServerSessions

(

StreamServer

streamServer

)

Returns stream server session buffer.

Warning

You should lock sessions before getting!

Parameters

streamServer

target stream server instance

getStreamServerSessionCount()

size_t getStreamServerSessionCount

(

StreamServer

streamServer

)

Returns stream server session buffer.

Warning

You should lock sessions before getting count!

Parameters

streamServer

target stream server instance

getStreamSessionSocket()

Socket getStreamSessionSocket

(

StreamSession

streamSession

)

Returns stream session socket instance.

Warning

You should lock sessions before getting socket!

Parameters

streamSession

target stream session instance

getStreamSessionRemoteAddress()

SocketAddress getStreamSessionRemoteAddress

(

StreamSession

streamSession

)

Returns stream session remote IP address instance.

Parameters

streamSession

target stream session instance

getStreamSessionHandle()

void * getStreamSessionHandle

(

StreamSession

streamSession

)

Returns stream session handle.

Warning

Handle may be null if socket is not fully connected!

Parameters

streamSession

target stream session instance

updateStreamSession()

int updateStreamSession	(	StreamServer	streamServer,
		StreamSession	streamSession,
		double	currentTime )

Updates specified stream server session state.

Warning

You should lock sessions before updating!

Returns

Zero on success, otherwise failure reason.

Parameters

streamServer	target stream server instance
streamSession	stream session instance to update
currentTime	current time value

destroyStreamSession()

void destroyStreamSession	(	StreamServer	streamServer,
		StreamSession	streamSession,
		int	reason )

Destroyes specified stream server session.

Warning

You should lock sessions before closing!

Parameters

streamServer	target stream server instance
streamSession	stream session instance to close
reason	stream session destruction reason

flushStreamSessions()

void flushStreamSessions

(

StreamServer

streamServer

)

Flushes destroyed stream server sessions.

Warning

You should lock sessions before closing!

Parameters

streamServer

target stream server instance

aliveStreamSession()

void aliveStreamSession

(

StreamSession

streamSession

)

Resets specified stream server session timeout time.

Warning

You should lock sessions before aliving!

Parameters

streamSession

target stream session instance

streamSessionSend()

NetsResult streamSessionSend	(	StreamSession	streamSession,
		const void *	data,
		size_t	byteCount )

Sends stream data to the specified session. (TCP).

Warning

You should lock sessions before sending messages!

Returns

The operation NetsResult code.

Parameters

	streamSession	target stream session instance
[in]	data	send data buffer
	byteCount	data byte count to send

streamServerSendDatagram()

NetsResult streamServerSendDatagram	(	StreamServer	streamServer,
		SocketAddress	remoteAddress,
		const void *	data,
		size_t	byteCount )

Sends datagram to the specified socket address. (UDP).

Returns

The operation NetsResult code.

Parameters

	streamServer	stream server instance
	remoteAddress	target remote socket IP address
[in]	data	send data buffer
	byteCount	data byte count to send

shutdownStreamSession()

NetsResult shutdownStreamSession	(	StreamSession	streamSession,
		SocketShutdown	shutdown )

Shutdowns part of the full-duplex socket connection.

Returns

The operation NetsResult code.

Parameters

streamSession	target stream session instance
shutdown	socket connection shutdown mode