-
-
Notifications
You must be signed in to change notification settings - Fork 31
/
link.h
85 lines (72 loc) · 2.27 KB
/
link.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/** @file link.h Network connection to a server.
*
* @authors Copyright © 2013-2017 Jaakko Keränen <jaakko.keranen@iki.fi>
*
* @par License
* LGPL: http://www.gnu.org/licenses/lgpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details. You should have received a copy of
* the GNU Lesser General Public License along with this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBSHELL_LINK_H
#define LIBSHELL_LINK_H
#include "libshell.h"
#include <de/Address>
#include <de/Socket>
#include <de/Time>
#include <de/Transmitter>
#include <de/shell/AbstractLink>
#include <de/shell/Protocol>
namespace de { namespace shell {
/**
* Network connection to a server using the shell protocol.
*
* @ingroup shell
*/
class LIBSHELL_PUBLIC Link : public AbstractLink
{
public:
DE_ERROR(ConnectError);
/**
* Opens a connection to a server over the network.
*
* @param domain Domain/IP address of the server.
* @param timeout Keep trying until this much time has passed.
*/
Link(String const &domain, TimeSpan const &timeout = 0.0);
/**
* Opens a connection to a server over the network.
*
* @param address Address of the server.
*/
Link(Address const &address);
/**
* Takes over an existing socket.
*
* @param openSocket Socket. Link takes ownership.
*/
Link(Socket *openSocket);
/**
* Shell protocol for constructing and interpreting packets.
*/
Protocol &protocol();
/**
* Opens the connection. This is an asynchronous operation. One can observe the
* state of the link via signals.
*/
void connectLink();
protected:
Packet *interpret(Message const &msg);
void initiateCommunications();
private:
DE_PRIVATE(d)
};
}} // namespace de::shell
#endif // LIBSHELL_LINK_H