Packet.h File Reference

#include <SFML/Config.h>

Go to the source code of this file.


Typedefs

typedef sfPacket sfPacket
 sfPacket wraps data to send / to receive through the network

Functions

CSFML_API sfPacketsfPacket_Create ()
 Create a new empty packet.
CSFML_API void sfPacket_Destroy (sfPacket *Packet)
 Destroy an existing packet.
CSFML_API void sfPacket_Append (sfPacket *Packet, void *Data, size_t SizeInBytes)
 Append data to the end of a packet.
CSFML_API void sfPacket_Clear (sfPacket *Packet)
 Clear all the data of a packet.
CSFML_API const char * sfPacket_GetData (sfPacket *Packet)
 Get a pointer to the data contained in a packet Warning : the returned pointer may be invalid after you append data to the packet.
CSFML_API size_t sfPacket_GetDataSize (sfPacket *Packet)
 Get the size of the data contained in a packet.
CSFML_API sfBool sfPacket_EndOfPacket (sfPacket *Packet)
 Tell if the reading position has reached the end of the packet.
CSFML_API sfBool sfPacket_CanRead (sfPacket *Packet)
 Return the validity of packet.
CSFML_API sfBool sfPacket_ReadBool (sfPacket *Packet)
 Functions to extract data from a packet.
CSFML_API sfInt8 sfPacket_ReadInt8 (sfPacket *Packet)
CSFML_API sfUint8 sfPacket_ReadUint8 (sfPacket *Packet)
CSFML_API sfInt16 sfPacket_ReadInt16 (sfPacket *Packet)
CSFML_API sfUint16 sfPacket_ReadUint16 (sfPacket *Packet)
CSFML_API sfInt32 sfPacket_ReadInt32 (sfPacket *Packet)
CSFML_API sfUint32 sfPacket_ReadUint32 (sfPacket *Packet)
CSFML_API float sfPacket_ReadFloat (sfPacket *Packet)
CSFML_API double sfPacket_ReadDouble (sfPacket *Packet)
CSFML_API void sfPacket_ReadString (sfPacket *Packet, char *String)
CSFML_API void sfPacket_ReadWideString (sfPacket *Packet, wchar_t *String)
CSFML_API void sfPacket_WriteBool (sfPacket *Packet, sfBool)
 Functions to insert data into a packet.
CSFML_API void sfPacket_WriteInt8 (sfPacket *Packet, sfInt8)
CSFML_API void sfPacket_WriteUint8 (sfPacket *Packet, sfUint8)
CSFML_API void sfPacket_WriteInt16 (sfPacket *Packet, sfInt16)
CSFML_API void sfPacket_WriteUint16 (sfPacket *Packet, sfUint16)
CSFML_API void sfPacket_WriteInt32 (sfPacket *Packet, sfInt32)
CSFML_API void sfPacket_WriteUint32 (sfPacket *Packet, sfUint32)
CSFML_API void sfPacket_WriteFloat (sfPacket *Packet, float)
CSFML_API void sfPacket_WriteDouble (sfPacket *Packet, double)
CSFML_API void sfPacket_WriteString (sfPacket *Packet, const char *String)
CSFML_API void sfPacket_WriteWideString (sfPacket *Packet, const wchar_t *String)

Typedef Documentation

typedef struct sfPacket sfPacket

sfPacket wraps data to send / to receive through the network

Definition at line 37 of file Packet.h.


Function Documentation

CSFML_API void sfPacket_Append ( sfPacket Packet,
void *  Data,
size_t  SizeInBytes 
)

Append data to the end of a packet.

Parameters:
Packet : Packet to fill
Data : Pointer to the bytes to append
SizeInBytes : Number of bytes to append

CSFML_API sfBool sfPacket_CanRead ( sfPacket Packet  ) 

Return the validity of packet.

Parameters:
Packet : Packet to check
Returns:
sfTrue if last data extraction from packet was successful

CSFML_API void sfPacket_Clear ( sfPacket Packet  ) 

Clear all the data of a packet.

Parameters:
Packet : Packet to clear

CSFML_API sfPacket* sfPacket_Create (  ) 

Create a new empty packet.

Returns:
A new sfPacket object

CSFML_API void sfPacket_Destroy ( sfPacket Packet  ) 

Destroy an existing packet.

Parameters:
Packet : Packet to delete

CSFML_API sfBool sfPacket_EndOfPacket ( sfPacket Packet  ) 

Tell if the reading position has reached the end of the packet.

Parameters:
Packet : Packet to check
Returns:
sfTrue if all data have been read into the packet

CSFML_API const char* sfPacket_GetData ( sfPacket Packet  ) 

Get a pointer to the data contained in a packet Warning : the returned pointer may be invalid after you append data to the packet.

Parameters:
Packet : Packet to get data from
Returns:
Pointer to the data

CSFML_API size_t sfPacket_GetDataSize ( sfPacket Packet  ) 

Get the size of the data contained in a packet.

Parameters:
Packet : Packet to get data size from
Returns:
Data size, in bytes

CSFML_API sfBool sfPacket_ReadBool ( sfPacket Packet  ) 

Functions to extract data from a packet.

Parameters:
Packet : Packet to read

CSFML_API double sfPacket_ReadDouble ( sfPacket Packet  ) 

CSFML_API float sfPacket_ReadFloat ( sfPacket Packet  ) 

CSFML_API sfInt16 sfPacket_ReadInt16 ( sfPacket Packet  ) 

CSFML_API sfInt32 sfPacket_ReadInt32 ( sfPacket Packet  ) 

CSFML_API sfInt8 sfPacket_ReadInt8 ( sfPacket Packet  ) 

CSFML_API void sfPacket_ReadString ( sfPacket Packet,
char *  String 
)

CSFML_API sfUint16 sfPacket_ReadUint16 ( sfPacket Packet  ) 

CSFML_API sfUint32 sfPacket_ReadUint32 ( sfPacket Packet  ) 

CSFML_API sfUint8 sfPacket_ReadUint8 ( sfPacket Packet  ) 

CSFML_API void sfPacket_ReadWideString ( sfPacket Packet,
wchar_t *  String 
)

CSFML_API void sfPacket_WriteBool ( sfPacket Packet,
sfBool   
)

Functions to insert data into a packet.

Parameters:
Packet : Packet to write

CSFML_API void sfPacket_WriteDouble ( sfPacket Packet,
double   
)

CSFML_API void sfPacket_WriteFloat ( sfPacket Packet,
float   
)

CSFML_API void sfPacket_WriteInt16 ( sfPacket Packet,
sfInt16   
)

CSFML_API void sfPacket_WriteInt32 ( sfPacket Packet,
sfInt32   
)

CSFML_API void sfPacket_WriteInt8 ( sfPacket Packet,
sfInt8   
)

CSFML_API void sfPacket_WriteString ( sfPacket Packet,
const char *  String 
)

CSFML_API void sfPacket_WriteUint16 ( sfPacket Packet,
sfUint16   
)

CSFML_API void sfPacket_WriteUint32 ( sfPacket Packet,
sfUint32   
)

CSFML_API void sfPacket_WriteUint8 ( sfPacket Packet,
sfUint8   
)

CSFML_API void sfPacket_WriteWideString ( sfPacket Packet,
const wchar_t *  String 
)