SocketUDP.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Network

SocketUDP.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_SOCKETUDP_HPP
#define SFML_SOCKETUDP_HPP

// Headers
#include <SFML/Network/SocketHelper.hpp>
#include <vector>
 
 
namespace sf
{
class Packet;
class IPAddress;
template <typename> class Selector;

class SFML_API SocketUDP
{
public :

    SocketUDP();

    void SetBlocking(bool Blocking);

    bool Bind(unsigned short Port);

    bool Unbind();

    Socket::Status Send(const char* Data, std::size_t Size, const IPAddress& Address, unsigned short Port);

    Socket::Status Receive(char* Data, std::size_t MaxSize, std::size_t& SizeReceived, IPAddress& Address, unsigned short& Port);

    Socket::Status Send(Packet& PacketToSend, const IPAddress& Address, unsigned short Port);

    Socket::Status Receive(Packet& PacketToReceive, IPAddress& Address, unsigned short& Port);

    bool Close();

    bool IsValid() const;

    unsigned short GetPort() const;

    bool operator ==(const SocketUDP& Other) const;

    bool operator !=(const SocketUDP& Other) const;

    bool operator <(const SocketUDP& Other) const;
 
private :
 
    friend class Selector<SocketUDP>;

    SocketUDP(SocketHelper::SocketType Descriptor);

    void Create(SocketHelper::SocketType Descriptor = 0);

    // Member data
    SocketHelper::SocketType mySocket;            
    unsigned short           myPort;              
    Uint32                   myPendingHeader;     
    Uint32                   myPendingHeaderSize; 
    std::vector<char>        myPendingPacket;     
    Int32                    myPendingPacketSize; 
    bool                     myIsBlocking;        
};
 
} // namespace sf
 
 
#endif // SFML_SOCKETUDP_HPP