documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::Packet Class Reference

Packet wraps data to send / to receive through the network. More...

#include <Packet.hpp>

List of all members.

Public Member Functions
	Packet ()
	Default constructor.
virtual	~Packet ()
	Virtual destructor.
void	Append (const void *Data, std::size_t SizeInBytes)
	Append data to the end of the packet.
void	Clear ()
	Clear the packet data.
const char *	GetData () const
	Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.
std::size_t	GetDataSize () const
	Get the size of the data contained in the packet.
bool	EndOfPacket () const
	Tell if the reading position has reached the end of the packet.
	operator bool () const
	Return the validity of packet.
Packet &	operator>> (bool &Data)
	Operator >> overloads to extract data from the packet.
Packet &	operator>> (Int8 &Data)
Packet &	operator>> (Uint8 &Data)
Packet &	operator>> (Int16 &Data)
Packet &	operator>> (Uint16 &Data)
Packet &	operator>> (Int32 &Data)
Packet &	operator>> (Uint32 &Data)
Packet &	operator>> (float &Data)
Packet &	operator>> (double &Data)
Packet &	operator>> (char *Data)
Packet &	operator>> (std::string &Data)
Packet &	operator>> (wchar_t *Data)
Packet &	operator>> (std::wstring &Data)
Packet &	operator<< (bool Data)
	Operator << overloads to put data into the packet.
Packet &	operator<< (Int8 Data)
Packet &	operator<< (Uint8 Data)
Packet &	operator<< (Int16 Data)
Packet &	operator<< (Uint16 Data)
Packet &	operator<< (Int32 Data)
Packet &	operator<< (Uint32 Data)
Packet &	operator<< (float Data)
Packet &	operator<< (double Data)
Packet &	operator<< (const char *Data)
Packet &	operator<< (const std::string &Data)
Packet &	operator<< (const wchar_t *Data)
Packet &	operator<< (const std::wstring &Data)
Friends
class	SocketTCP
class	SocketUDP

---

Detailed Description

Packet wraps data to send / to receive through the network.

Definition at line 41 of file Packet.hpp.

---

Constructor & Destructor Documentation

sf::Packet::Packet

(

)

Default constructor.

Definition at line 38 of file Packet.cpp.

sf::Packet::~Packet

(

)

[virtual]

Virtual destructor.

Definition at line 49 of file Packet.cpp.

---

Member Function Documentation

void sf::Packet::Append	(	const void *	Data,
		std::size_t	SizeInBytes
	)

Append data to the end of the packet.

Parameters:

	Data	: Pointer to the bytes to append
	SizeInBytes	: Number of bytes to append

Definition at line 58 of file Packet.cpp.

void sf::Packet::Clear

(

)

Clear the packet data.

Definition at line 72 of file Packet.cpp.

bool sf::Packet::EndOfPacket

(

)

const

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

Returns:

True if all data have been read into the packet

Definition at line 103 of file Packet.cpp.

const char * sf::Packet::GetData

(

)

const

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

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

Returns:

Pointer to the data

Definition at line 85 of file Packet.cpp.

std::size_t sf::Packet::GetDataSize

(

)

const

Get the size of the data contained in the packet.

Returns:

Data size, in bytes

Definition at line 94 of file Packet.cpp.

sf::Packet::operator bool

(

)

const

Return the validity of packet.

Tell if the packet is valid for reading.

Returns:

True if last data extraction from packet was successful

Definition at line 112 of file Packet.cpp.

Packet & sf::Packet::operator<<

(

bool

Data

)

Operator << overloads to put data into the packet.

Definition at line 290 of file Packet.cpp.

Packet & sf::Packet::operator>>

(

bool &

Data

)

Operator >> overloads to extract data from the packet.

Definition at line 121 of file Packet.cpp.

---

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

• Packet.hpp
• Packet.cpp

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  :: 

previous page start next page

Menu

• Homepage

Table of contents

• Main Page
• Class List
  • sf::AudioResource
  • sf::Clock
  • sf::Color
  • sf::Context
  • sf::Drawable
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Font
  • sf::Ftp
  • sf::Ftp::Ftp::DirectoryResponse
  • sf::Ftp::Ftp::ListingResponse
  • sf::Ftp::Ftp::Response
  • sf::Glyph
  • sf::Http
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::Image
  • sf::Input
  • sf::IPAddress
  • sf::Listener
  • sf::Lock
  • sf::Matrix3
  • sf::Music
  • sf::Mutex
  • sf::NonCopyable
  • sf::Packet
  • sf::PostFX
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
  • sf::RenderWindow
  • sf::Resource< T >
  • sf::ResourcePtr< T >
  • sf::Selector< Type >
  • sf::SelectorBase
  • sf::Shape
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::Sound
  • sf::SoundBuffer
  • sf::SoundBufferRecorder
  • sf::SoundRecorder
  • sf::SoundStream
  • sf::SoundStream::SoundStream::Chunk
  • sf::Sprite
  • sf::String
  • sf::Thread
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::Window
  • sf::WindowListener
  • sf::WindowSettings
• Class Hierarchy
  • sf::AudioResource
    • sf::Sound
      • sf::SoundStream
        • sf::Music
    • sf::SoundBuffer
  • sf::Clock
  • sf::Color
  • sf::Drawable
    • sf::PostFX
    • sf::Shape
    • sf::Sprite
    • sf::String
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Ftp::Ftp::Response
    • sf::Ftp::Ftp::DirectoryResponse
    • sf::Ftp::Ftp::ListingResponse
  • sf::Glyph
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::IPAddress
  • sf::Listener
  • sf::Matrix3
  • sf::NonCopyable
    • sf::Context
    • sf::Ftp
    • sf::Http
    • sf::Input
    • sf::Lock
    • sf::Mutex
    • sf::Thread
      • sf::SoundRecorder
        • sf::SoundBufferRecorder
      • sf::SoundStream
    • sf::Window
      • sf::RenderWindow
  • sf::Packet
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
    • sf::RenderWindow
  • sf::Resource< T >
  • sf::Resource< Font >
    • sf::Font
  • sf::Resource< Image >
    • sf::Image
  • sf::Resource< SoundBuffer >
    • sf::SoundBuffer
  • sf::ResourcePtr< T >
  • sf::SelectorBase
    • sf::Selector< Type >
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::SoundStream::SoundStream::Chunk
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::WindowListener
    • sf::Input
    • sf::Window
  • sf::WindowSettings
• Class Members
• Namespace List
  • sf::Blend
  • sf::Joy
  • sf::Key
  • sf::Mouse
  • sf::Style
• Namespace Members
• File List
  • Arial.hpp
  • Audio.hpp
  • AudioDevice.cpp
  • AudioDevice.hpp
  • AudioResource.cpp
  • AudioResource.hpp
  • Clock.cpp
  • Clock.hpp
  • Color.cpp
  • Color.hpp
  • Config.hpp
  • Context.cpp
  • Context.hpp
  • Doxygen.hpp
  • Drawable.cpp
  • Drawable.hpp
  • Event.hpp
  • Font.cpp
  • Font.hpp
  • FontLoader.cpp
  • FontLoader.hpp
  • Ftp.cpp
  • Ftp.hpp
  • Glyph.hpp
  • Graphics.hpp
  • GraphicsContext.cpp
  • GraphicsContext.hpp
  • Http.cpp
  • Http.hpp
  • Image.cpp
  • Image.hpp
  • ImageLoader.cpp
  • ImageLoader.hpp
  • Input.cpp
  • Input.hpp
  • IPAddress.cpp
  • IPAddress.hpp
  • Cocoa/Joystick.cpp
  • Template for new ports/Joystick.cpp
  • Win32/Joystick.cpp
  • Cocoa/Joystick.hpp
  • Joystick.hpp
  • Template for new ports/Joystick.hpp
  • Win32/Joystick.hpp
  • Listener.cpp
  • Listener.hpp
  • Lock.cpp
  • Lock.hpp
  • Matrix3.cpp
  • Matrix3.hpp
  • Matrix3.inl
  • Music.cpp
  • Music.hpp
  • Mutex.cpp
  • Mutex.hpp
  • Win32/Mutex.hpp
  • Network.hpp
  • NonCopyable.hpp
  • OpenAL.hpp
  • OpenGL.hpp
  • Packet.cpp
  • Packet.hpp
  • Platform.cpp
  • Platform.hpp
  • Win32/Platform.hpp
  • PostFX.cpp
  • PostFX.hpp
  • Randomizer.cpp
  • Randomizer.hpp
  • Rect.hpp
  • Rect.inl
  • RenderTarget.cpp
  • RenderTarget.hpp
  • RenderWindow.cpp
  • RenderWindow.hpp
  • Resource.hpp
  • Resource.inl
  • ResourcePtr.inl
  • Selector.hpp
  • Selector.inl
  • SelectorBase.cpp
  • SelectorBase.hpp
  • SFML_Main.cpp
  • Shape.cpp
  • Shape.hpp
  • Sleep.cpp
  • Sleep.hpp
  • SocketHelper.cpp
  • SocketHelper.hpp
  • Win32/SocketHelper.hpp
  • Sockets.hpp
  • SocketTCP.cpp
  • SocketTCP.hpp
  • SocketUDP.cpp
  • SocketUDP.hpp
  • Sound.cpp
  • Sound.hpp
  • SoundBuffer.cpp
  • SoundBuffer.hpp
  • SoundBufferRecorder.cpp
  • SoundBufferRecorder.hpp
  • SoundFile.cpp
  • SoundFile.hpp
  • SoundFileDefault.cpp
  • SoundFileDefault.hpp
  • SoundFileOgg.cpp
  • SoundFileOgg.hpp
  • SoundRecorder.cpp
  • SoundRecorder.hpp
  • SoundStream.cpp
  • SoundStream.hpp
  • Sprite.cpp
  • Sprite.hpp
  • String.cpp
  • String.hpp
  • System.hpp
  • Thread.cpp
  • Thread.hpp
  • Win32/Thread.hpp
  • Unicode.cpp
  • Unicode.hpp
  • Unicode.inl
  • Vector2.hpp
  • Vector2.inl
  • Vector3.hpp
  • Vector3.inl
  • VideoMode.cpp
  • VideoMode.hpp
  • Cocoa/VideoModeSupport.cpp
  • Template for new ports/VideoModeSupport.cpp
  • Win32/VideoModeSupport.cpp
  • Cocoa/VideoModeSupport.hpp
  • Template for new ports/VideoModeSupport.hpp
  • VideoModeSupport.hpp
  • Win32/VideoModeSupport.hpp
  • View.cpp
  • View.hpp
  • Window.cpp
  • Window/Window.hpp
  • Window.hpp
  • WindowHandle.hpp
  • WindowImpl.cpp
  • WindowImpl.hpp
  • WindowImplCocoa.hpp
  • WindowImplWin32.cpp
  • WindowImplWin32.hpp
  • WindowImplXXX.cpp
  • WindowImplXXX.hpp
  • WindowListener.hpp
  • WindowSettings.hpp
  • WindowStyle.hpp

Get in touch

Submit feedback about this site to:

• [email protected]

© documentation.help. Design: rehmann.co.