CSFML

- Main Page
- Data Structures
- Files

- File List
- Globals

Packet.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24
25 #ifndef SFML_PACKET_H
26 #define SFML_PACKET_H
27
29 // Headers
31 #include <SFML/Network/Export.h>
32 #include <SFML/Network/Types.h>
33 #include <stddef.h>
34
35
42 CSFML_NETWORK_API sfPacket* sfPacket_create(void);
43
52 CSFML_NETWORK_API sfPacket* sfPacket_copy(const sfPacket* packet);
53
60 CSFML_NETWORK_API void sfPacket_destroy(sfPacket* packet);
61
70 CSFML_NETWORK_API void sfPacket_append(sfPacket* packet, const void* data, size_t sizeInBytes);
71
80 CSFML_NETWORK_API void sfPacket_clear(sfPacket* packet);
81
95 CSFML_NETWORK_API const void* sfPacket_getData(const sfPacket* packet);
96
108 CSFML_NETWORK_API size_t sfPacket_getDataSize(const sfPacket* packet);
109
122 CSFML_NETWORK_API sfBool sfPacket_endOfPacket(const sfPacket* packet);
123
138 CSFML_NETWORK_API sfBool sfPacket_canRead(const sfPacket* packet);
139
146 CSFML_NETWORK_API sfBool sfPacket_readBool(sfPacket* packet);
147 CSFML_NETWORK_API sfInt8 sfPacket_readInt8(sfPacket* packet);
148 CSFML_NETWORK_API sfUint8 sfPacket_readUint8(sfPacket* packet);
149 CSFML_NETWORK_API sfInt16 sfPacket_readInt16(sfPacket* packet);
150 CSFML_NETWORK_API sfUint16 sfPacket_readUint16(sfPacket* packet);
151 CSFML_NETWORK_API sfInt32 sfPacket_readInt32(sfPacket* packet);
152 CSFML_NETWORK_API sfUint32 sfPacket_readUint32(sfPacket* packet);
153 CSFML_NETWORK_API float sfPacket_readFloat(sfPacket* packet);
154 CSFML_NETWORK_API double sfPacket_readDouble(sfPacket* packet);
155 CSFML_NETWORK_API void sfPacket_readString(sfPacket* packet, char* string);
156 CSFML_NETWORK_API void sfPacket_readWideString(sfPacket* packet, wchar_t* string);
157
164 CSFML_NETWORK_API void sfPacket_writeBool(sfPacket* packet, sfBool);
165 CSFML_NETWORK_API void sfPacket_writeInt8(sfPacket* packet, sfInt8);
166 CSFML_NETWORK_API void sfPacket_writeUint8(sfPacket* packet, sfUint8);
167 CSFML_NETWORK_API void sfPacket_writeInt16(sfPacket* packet, sfInt16);
168 CSFML_NETWORK_API void sfPacket_writeUint16(sfPacket* packet, sfUint16);
169 CSFML_NETWORK_API void sfPacket_writeInt32(sfPacket* packet, sfInt32);
170 CSFML_NETWORK_API void sfPacket_writeUint32(sfPacket* packet, sfUint32);
171 CSFML_NETWORK_API void sfPacket_writeFloat(sfPacket* packet, float);
172 CSFML_NETWORK_API void sfPacket_writeDouble(sfPacket* packet, double);
173 CSFML_NETWORK_API void sfPacket_writeString(sfPacket* packet, const char* string);
174 CSFML_NETWORK_API void sfPacket_writeWideString(sfPacket* packet, const wchar_t* string);
175
176
177 #endif // SFML_PACKET_H
sfPacket_writeDouble
CSFML_NETWORK_API void sfPacket_writeDouble(sfPacket *packet, double)
sfPacket_readUint8
CSFML_NETWORK_API sfUint8 sfPacket_readUint8(sfPacket *packet)
Types.h
sfPacket_getDataSize
CSFML_NETWORK_API size_t sfPacket_getDataSize(const sfPacket *packet)
Get the size of the data contained in a packet.
sfPacket_writeFloat
CSFML_NETWORK_API void sfPacket_writeFloat(sfPacket *packet, float)
sfPacket_destroy
CSFML_NETWORK_API void sfPacket_destroy(sfPacket *packet)
Destroy a packet.
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfPacket_readString
CSFML_NETWORK_API void sfPacket_readString(sfPacket *packet, char *string)
sfPacket_writeBool
CSFML_NETWORK_API void sfPacket_writeBool(sfPacket *packet, sfBool)
Functions to insert data into a packet.
sfPacket_writeUint8
CSFML_NETWORK_API void sfPacket_writeUint8(sfPacket *packet, sfUint8)
sfPacket_writeWideString
CSFML_NETWORK_API void sfPacket_writeWideString(sfPacket *packet, const wchar_t *string)
sfPacket_readUint32
CSFML_NETWORK_API sfUint32 sfPacket_readUint32(sfPacket *packet)
sfInt8
signed char sfInt8
Definition: Config.h:120
sfPacket_canRead
CSFML_NETWORK_API sfBool sfPacket_canRead(const sfPacket *packet)
Test the validity of a packet, for reading.
sfInt16
signed short sfInt16
Definition: Config.h:124
sfBool
int sfBool
Definition: Config.h:106
sfPacket_writeInt16
CSFML_NETWORK_API void sfPacket_writeInt16(sfPacket *packet, sfInt16)
sfPacket_copy
CSFML_NETWORK_API sfPacket * sfPacket_copy(const sfPacket *packet)
Create a new packet by copying an existing one.
sfInt32
signed int sfInt32
Definition: Config.h:128
sfPacket
struct sfPacket sfPacket
Definition: Network/Types.h:36
sfUint16
unsigned short sfUint16
Definition: Config.h:125
sfPacket_readInt32
CSFML_NETWORK_API sfInt32 sfPacket_readInt32(sfPacket *packet)
sfPacket_readInt16
CSFML_NETWORK_API sfInt16 sfPacket_readInt16(sfPacket *packet)
sfPacket_writeInt8
CSFML_NETWORK_API void sfPacket_writeInt8(sfPacket *packet, sfInt8)
sfPacket_writeInt32
CSFML_NETWORK_API void sfPacket_writeInt32(sfPacket *packet, sfInt32)
sfUint32
unsigned int sfUint32
Definition: Config.h:129
sfPacket_readBool
CSFML_NETWORK_API sfBool sfPacket_readBool(sfPacket *packet)
Functions to extract data from a packet.
sfPacket_append
CSFML_NETWORK_API void sfPacket_append(sfPacket *packet, const void *data, size_t sizeInBytes)
Append data to the end of a packet.
sfPacket_writeString
CSFML_NETWORK_API void sfPacket_writeString(sfPacket *packet, const char *string)
sfPacket_getData
CSFML_NETWORK_API const void * sfPacket_getData(const sfPacket *packet)
Get a pointer to the data contained in a packet.
sfPacket_create
CSFML_NETWORK_API sfPacket * sfPacket_create(void)
Create a new packet.
sfPacket_readUint16
CSFML_NETWORK_API sfUint16 sfPacket_readUint16(sfPacket *packet)
sfPacket_writeUint32
CSFML_NETWORK_API void sfPacket_writeUint32(sfPacket *packet, sfUint32)
sfPacket_readFloat
CSFML_NETWORK_API float sfPacket_readFloat(sfPacket *packet)
sfUint8
unsigned char sfUint8
Definition: Config.h:121
sfPacket_clear
CSFML_NETWORK_API void sfPacket_clear(sfPacket *packet)
Clear a packet.
sfPacket_writeUint16
CSFML_NETWORK_API void sfPacket_writeUint16(sfPacket *packet, sfUint16)
Export.h
sfPacket_readDouble
CSFML_NETWORK_API double sfPacket_readDouble(sfPacket *packet)
sfPacket_readWideString
CSFML_NETWORK_API void sfPacket_readWideString(sfPacket *packet, wchar_t *string)
sfPacket_endOfPacket
CSFML_NETWORK_API sfBool sfPacket_endOfPacket(const sfPacket *packet)
Tell if the reading position has reached the end of a packet.
sfPacket_readInt8
CSFML_NETWORK_API sfInt8 sfPacket_readInt8(sfPacket *packet)