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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*
* ZeroTier One - Global Peer to Peer Ethernet
* Copyright (C) 2012-2013 ZeroTier Networks LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* --
*
* ZeroTier may be used and distributed under the terms of the GPLv3, which
* are available at: http://www.gnu.org/licenses/gpl-3.0.html
*
* If you would like to embed ZeroTier into a commercial application or
* redistribute it in a modified binary form, please contact ZeroTier Networks
* LLC. Start here: http://www.zerotier.com/
*/
#ifndef _ZT_NODE_HPP
#define _ZT_NODE_HPP
namespace ZeroTier {
/**
* A ZeroTier One node
*
* This class hides all its implementation details and all other classes in
* preparation for ZeroTier One being made available in library form for
* embedding in mobile apps.
*/
class Node
{
public:
/**
* Client for controlling a local ZeroTier One node
*/
class LocalClient
{
public:
/**
* Create a new node config client
*
* @param authToken Authentication token
* @param resultHandler Function to call when commands provide results
*/
LocalClient(const char *authToken,void (*resultHandler)(void *,unsigned long,const char *),void *arg)
throw();
~LocalClient();
/**
* Send a command to the local node
*
* Note that the returned conversation ID will never be 0. A return value
* of 0 indicates a fatal error such as failure to bind to any local UDP
* port.
*
* @param command
* @return Conversation ID that will be provided to result handler when/if results are sent back
*/
unsigned long send(const char *command)
throw();
private:
// LocalClient is not copyable
LocalClient(const LocalClient&);
const LocalClient& operator=(const LocalClient&);
void *_impl;
};
/**
* Returned by node main if/when it terminates
*/
enum ReasonForTermination
{
NODE_RUNNING = 0,
NODE_NORMAL_TERMINATION = 1,
NODE_RESTART_FOR_RECONFIGURATION = 2,
NODE_UNRECOVERABLE_ERROR = 3
};
/**
* Create a new node
*
* The node is not executed until run() is called.
*
* @param hp Home directory path
*/
Node(const char *hp)
throw();
~Node();
/**
* Execute node in current thread
*
* This does not return until the node shuts down. Shutdown may be caused
* by an internally detected condition such as a new upgrade being
* available or a fatal error, or it may be signaled externally using
* the terminate() method.
*
* @return Reason for termination
*/
ReasonForTermination run()
throw();
/**
* Obtain a human-readable reason for node termination
*
* @return Reason for node termination or NULL if run() has not returned
*/
const char *reasonForTermination() const
throw();
/**
* Cause run() to return
*
* This can be called from a signal handler or another thread to signal a
* running node to shut down. Shutdown may take a few seconds, so run()
* may not return instantly. Multiple calls are ignored.
*
* @param reason Reason for termination
* @param reasonText Text to be returned by reasonForTermination()
*/
void terminate(ReasonForTermination reason,const char *reasonText)
throw();
/**
* Get the ZeroTier version in major.minor.revision string format
*
* @return Version in string form
*/
static const char *versionString()
throw();
static unsigned int versionMajor() throw();
static unsigned int versionMinor() throw();
static unsigned int versionRevision() throw();
private:
// Nodes are not copyable
Node(const Node&);
const Node& operator=(const Node&);
void *const _impl; // private implementation
};
/**
* An embedded version code that can be searched for in the binary
*
* This shouldn't be used by users, but is exported to make certain that
* the linker actually includes it in the image.
*/
extern const unsigned char EMBEDDED_VERSION_STAMP[20];
} // namespace ZeroTier
extern "C" {
// Functions with C-style linkage for easy DLL symbol table
// lookup. These just create instances of Node and LocalClient.
ZeroTier::Node *zeroTierCreateNode(const char *hp);
void zeroTierDeleteNode(ZeroTier::Node *n);
ZeroTier::Node::LocalClient *zeroTierCreateLocalClient(const char *authToken,void (*resultHandler)(void *,unsigned long,const char *),void *arg);
void zeroTierDeleteLocalClient(ZeroTier::Node::LocalClient *lc);
} // extern "C"
#endif
|
