PSC_EADataReceived Class Reference

Event arguments for data received on a connection. More...

#include <poser/core/connection.h>

Public Member Functions
const uint8_t *	PSC_EADataReceived_buf (const PSC_EADataReceived *self)
	The data received.
size_t	PSC_EADataReceived_size (const PSC_EADataReceived *self)
	The size of the data received.
const char *	PSC_EADataReceived_text (const PSC_EADataReceived *self)
	The text received.
void	PSC_EADataReceived_markHandling (PSC_EADataReceived *self)
	Mark received data as being handled.

Detailed Description

Event arguments for data received on a connection.

Member Function Documentation

PSC_EADataReceived_buf()

const uint8_t * PSC_EADataReceived_buf

(

const PSC_EADataReceived *

self

)

The data received.

Get a pointer to the data received on a connection. This is used when receiving in binary mode. In text mode, it returns NULL.

Parameters

self	the PSC_EADataReceived

Returns

a pointer to received data

PSC_EADataReceived_markHandling()

void PSC_EADataReceived_markHandling

(

PSC_EADataReceived *

self

)

Mark received data as being handled.

Calling this makes the PSC_Connection stop receiving further data unless PSC_Connection_confirmDataReceived() is called. Each call to this function requires a corresponding call to PSC_Connection_confirmDataReceived() to actually resume receiving.

Parameters

self	the PSC_EADataReceived

PSC_EADataReceived_size()

size_t PSC_EADataReceived_size

(

const PSC_EADataReceived *

self

)

The size of the data received.

Get the size of the received data (in bytes). This is used when receiving in binary mode. In text mode, it returns 0.

Parameters

self	the PSC_EADataReceived

Returns

the size of the data

PSC_EADataReceived_text()

const char * PSC_EADataReceived_text

(

const PSC_EADataReceived *

self

)

The text received.

Get a pointer to the text received on a connection. This is used when receiving in text mode. In binary mode, it returns NULL.

Parameters

self	the PSC_EADataReceived

Returns

a pointer to received text

---

The documentation for this class was generated from the following file:

• poser/core/connection.h