connection.h Source File - ClanLib SDK
Description: connection.h Source File

connection.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 The ClanLib Team
4**
5** This software is provided 'as-is', without any express or implied
6** warranty. In no event will the authors be held liable for any damages
7** 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
11** freely, subject to the following restrictions:
12**
13** 1. The origin of this software must not be misrepresented; you must not
14** claim that you wrote the original software. If you use this software
15** in a product, an acknowledgment in the product documentation would be
16** appreciated but is not required.
17** 2. Altered source versions must be plainly marked as such, and must not be
18** misrepresented as being the original software.
19** 3. This notice may not be removed or altered from any source distribution.
20**
21** Note: Some of the libraries ClanLib may link to may have additional
22** requirements or restrictions.
23**
24** File Author(s):
25**
26** Magnus Norddahl
27*/
28
29#pragma once
30
31#include <vector>
32#include <string>
33#include "event.h"
34
35namespace clan
36{
39
40 class NetGameConnectionSite;
41 class NetGameConnection_Impl;
42 class SocketName;
43 class TCPConnection;
44
46 class NetGameConnection
47 {
48 public:
53 NetGameConnection(NetGameConnectionSite *site, const TCPConnection &connection);
54 NetGameConnection(NetGameConnectionSite *site, const SocketName &socket_name);
55
56 ~NetGameConnection();
57
62 void set_data(const std::string &name, void *data);
63
69 void *get_data(const std::string &name) const;
70
74 void send_event(const NetGameEvent &game_event);
75
77 void disconnect();
78
82 SocketName get_remote_name() const;
83
84 private:
86 NetGameConnection(NetGameConnection &other) = delete;
87 NetGameConnection &operator =(const NetGameConnection &other) = delete;
88
89 NetGameConnection_Impl *impl;
90 };
91
93}
clan::NetGameConnectionSite
NetGameConnectionSite.
Definition connection_site.h:40
clan::NetGameConnection
NetGameConnection.
Definition connection.h:47
clan::NetGameConnection::disconnect
void disconnect()
Disconnects a client.
clan::NetGameConnection::send_event
void send_event(const NetGameEvent &game_event)
Send event.
clan::NetGameConnection::NetGameConnection
NetGameConnection(NetGameConnectionSite *site, const SocketName &socket_name)
clan::NetGameConnection::~NetGameConnection
~NetGameConnection()
clan::NetGameConnection::get_remote_name
SocketName get_remote_name() const
Get Remote name.
clan::NetGameConnection::NetGameConnection
NetGameConnection(NetGameConnectionSite *site, const TCPConnection &connection)
Constructs a NetGameConnection.
clan::NetGameConnection::set_data
void set_data(const std::string &name, void *data)
Set data.
clan::NetGameConnection::get_data
void * get_data(const std::string &name) const
Get data.
clan::NetGameEvent
NetGameEvent.
Definition Network/NetGame/event.h:40
clan::SocketName
Socket name; container class for an IP address and port.
Definition socket_name.h:45
clan::TCPConnection
TCP/IP socket connection.
Definition tcp_connection.h:18
clan
Definition clanapp.h:36