documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::SocketTCP Class Reference

SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower). More...

#include <SocketTCP.hpp>

List of all members.

Public Member Functions
	SocketTCP ()
	Default constructor.
void	SetBlocking (bool Blocking)
	Change the blocking state of the socket.
Socket::Status	Connect (unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f)
	Connect to another computer on a specified port.
bool	Listen (unsigned short Port)
	Listen to a specified port for incoming data or connections.
Socket::Status	Accept (SocketTCP &Connected, IPAddress *Address=NULL)
	Wait for a connection (must be listening to a port).
Socket::Status	Send (const char *Data, std::size_t Size)
	Send an array of bytes to the host (must be connected first).
Socket::Status	Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived)
	Receive an array of bytes from the host (must be connected first).
Socket::Status	Send (Packet &PacketToSend)
	Send a packet of data to the host (must be connected first).
Socket::Status	Receive (Packet &PacketToReceive)
	Receive a packet from the host (must be connected first).
bool	Close ()
	Close the socket.
bool	IsValid () const
	Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
bool	operator== (const SocketTCP &Other) const
	Comparison operator ==.
bool	operator!= (const SocketTCP &Other) const
	Comparison operator !=.
bool	operator< (const SocketTCP &Other) const
	Comparison operator <.
Friends
class	Selector< SocketTCP >

---

Detailed Description

SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower).

Definition at line 45 of file SocketTCP.hpp.

---

Constructor & Destructor Documentation

sf::SocketTCP::SocketTCP

(

)

Default constructor.

Definition at line 47 of file SocketTCP.cpp.

---

Member Function Documentation

Socket::Status sf::SocketTCP::Accept	(	SocketTCP &	Connected,
		IPAddress *	Address = NULL
	)

Wait for a connection (must be listening to a port).

This function will block if the socket is blocking

Parameters:

	Connected	: Socket containing the connection with the connected client
	Address	: Pointer to an address to fill with client infos (NULL by default)

Returns:

Status code

This function will block if the socket is blocking

Definition at line 206 of file SocketTCP.cpp.

bool sf::SocketTCP::Close

(

)

Close the socket.

Returns:

True if operation has been successful

Definition at line 406 of file SocketTCP.cpp.

Socket::Status sf::SocketTCP::Connect	(	unsigned short	Port,
		const IPAddress &	HostAddress,
		float	Timeout = 0.f
	)

Connect to another computer on a specified port.

Parameters:

	Port	: Port to use for transfers (warning : ports < 1024 are reserved)
	HostAddress	: IP Address of the host to connect to
	Timeout	: Maximum time to wait, in seconds (0 by default : no timeout) (this parameter is ignored for non-blocking sockets)

Returns:

True if operation has been successful

Definition at line 70 of file SocketTCP.cpp.

bool sf::SocketTCP::IsValid

(

)

const

Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

Returns:

True if the socket is valid

Definition at line 429 of file SocketTCP.cpp.

bool sf::SocketTCP::Listen

(

unsigned short

Port

)

Listen to a specified port for incoming data or connections.

Parameters:

Port

: Port to listen to

Returns:

True if operation has been successful

Definition at line 169 of file SocketTCP.cpp.

bool sf::SocketTCP::operator!=

(

const SocketTCP &

Other

)

const

Comparison operator !=.

Parameters:

Other

: Socket to compare

Returns:

True if *this != Other

Definition at line 447 of file SocketTCP.cpp.

bool sf::SocketTCP::operator<

(

const SocketTCP &

Other

)

const

Comparison operator <.

Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Parameters:

Other

: Socket to compare

Returns:

True if *this < Other

Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Definition at line 458 of file SocketTCP.cpp.

bool sf::SocketTCP::operator==

(

const SocketTCP &

Other

)

const

Comparison operator ==.

Parameters:

Other

: Socket to compare

Returns:

True if *this == Other

Definition at line 438 of file SocketTCP.cpp.

Socket::Status sf::SocketTCP::Receive

(

Packet &

PacketToReceive

)

Receive a packet from the host (must be connected first).

This function will block if the socket is blocking

Parameters:

PacketToReceive

: Packet to fill with received data

Returns:

Status code

This function will block if the socket is blocking

Definition at line 340 of file SocketTCP.cpp.

Socket::Status sf::SocketTCP::Receive	(	char *	Data,
		std::size_t	MaxSize,
		std::size_t &	SizeReceived
	)

Receive an array of bytes from the host (must be connected first).

This function will block if the socket is blocking

Parameters:

	Data	: Pointer to a byte array to fill (make sure it is big enough)
	MaxSize	: Maximum number of bytes to read
	SizeReceived	: Number of bytes received

Returns:

Status code

This function will block if the socket is blocking

Definition at line 272 of file SocketTCP.cpp.

Socket::Status sf::SocketTCP::Send

(

Packet &

PacketToSend

)

Send a packet of data to the host (must be connected first).

Parameters:

PacketToSend

: Packet to send

Returns:

Status code

Definition at line 314 of file SocketTCP.cpp.

Socket::Status sf::SocketTCP::Send	(	const char *	Data,
		std::size_t	Size
	)

Send an array of bytes to the host (must be connected first).

Parameters:

	Data	: Pointer to the bytes to send
	Size	: Number of bytes to send

Returns:

Status code

Definition at line 235 of file SocketTCP.cpp.

void sf::SocketTCP::SetBlocking

(

bool

Blocking

)

Change the blocking state of the socket.

The default behaviour of a socket is blocking

Parameters:

Blocking

: Pass true to set the socket as blocking, or false for non-blocking

Definition at line 56 of file SocketTCP.cpp.

---

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

• SocketTCP.hpp
• SocketTCP.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.