udp_socket.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Magnus Norddahl
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../api_network.h"
00035 #include "../../Core/System/sharedptr.h"
00036 
00037 class CL_Event;
00038 class CL_SocketName;
00039 class CL_UDPSocket_Impl;
00040 
00044 class CL_API_NETWORK CL_UDPSocket
00045 {
00048 
00049 public:
00050         CL_UDPSocket();
00051 
00056         CL_UDPSocket(const CL_SocketName &local_name, bool force_bind = true);
00057 
00062         CL_UDPSocket(int socket, bool close_socket);
00063 
00064         ~CL_UDPSocket();
00065 
00069 
00070 public:
00071 
00075         int get_handle() const;
00076 
00080         CL_SocketName get_local_name() const;
00081 
00085         CL_Event get_read_event();
00086 
00090         CL_Event get_write_event();
00091 
00095 
00096 public:
00097 
00102         void bind(const CL_SocketName &local_name, bool force_bind = true);
00103 
00108         void set_handle(int socket, bool close_socket);
00109 
00117         int send(const void *data, int len, const CL_SocketName &to);
00118 
00126         int receive(void *data, int len, CL_SocketName &out_from);
00127 
00135         int peek(void *data, int len, CL_SocketName &out_from);
00136 
00140 
00141 private:
00142         CL_SharedPtr<CL_UDPSocket_Impl> impl;
00144 };
00145