~ubuntu-branches/debian/stretch/libnice/stretch

Viewing changes to docs/reference/libnice/html/libnice-StunAgent.html

Committer: Bazaar Package Importer
Author(s): Sjoerd Simons
Date: 2011-02-07 13:02:37 UTC
mfrom: (1.2.5 upstream) (5.1.7 sid) (5.2.2 experimental)
Revision ID: james.westby@ubuntu.com-20110207130237-2msz0lsijzd3putz

Tags: 0.1.0-2

Add a Breaks: libgstfarsight0.10-0 (<< 0.22) for the gstreamer plugin as
farsight uses one libnice ABI and the gstreamer element uses another
libnice ABI things tend to go horribly wrong.

files added:
debian/source

debian/source/format

files renamed:
debian/libnice0.install => debian/libnice10.install

debian/libnice0.symbols => debian/libnice10.symbols

files modified:
Makefile.in

NEWS

aclocal.m4

agent/Makefile.in

agent/agent-signals-marshal.c

agent/agent.c

agent/agent.h

agent/component.c

agent/component.h

agent/conncheck.c

agent/debug.c

agent/discovery.c

agent/interfaces.c

agent/pseudotcp.c

agent/stream.c

config.guess

config.sub

configure

configure.ac

debian/changelog

debian/control

debian/copyright

debian/rules

docs/Makefile.in

docs/reference/Makefile.in

docs/reference/libnice/Makefile.in

docs/reference/libnice/html/NiceAgent.html

docs/reference/libnice/html/ch01.html

docs/reference/libnice/html/ch02.html

docs/reference/libnice/html/ch03.html

docs/reference/libnice/html/ch04.html

docs/reference/libnice/html/ch05.html

docs/reference/libnice/html/index.html

docs/reference/libnice/html/index.sgml

docs/reference/libnice/html/libnice-Bind.html

docs/reference/libnice/html/libnice-Debug-messages.html

docs/reference/libnice/html/libnice-ICE.html

docs/reference/libnice/html/libnice-Network-interfaces-discovery.html

docs/reference/libnice/html/libnice-NiceAddress.html

docs/reference/libnice/html/libnice-NiceCandidate.html

docs/reference/libnice/html/libnice-Pseudo-TCP-Socket.html

docs/reference/libnice/html/libnice-StunAgent.html

docs/reference/libnice/html/libnice-StunMessage.html

docs/reference/libnice/html/libnice-TURN.html

docs/reference/libnice/html/libnice-Timer.html

docs/reference/libnice/html/libnice.devhelp

docs/reference/libnice/html/libnice.devhelp2

docs/reference/libnice/html/pt01.html

docs/reference/libnice/html/pt02.html

docs/reference/libnice/html/pt03.html

docs/reference/libnice/html/style.css

docs/reference/libnice/libnice-sections.txt

docs/reference/libnice/tmpl/address.sgml

docs/reference/libnice/tmpl/agent.sgml

docs/reference/libnice/tmpl/bind.sgml

docs/reference/libnice/tmpl/candidate.sgml

docs/reference/libnice/tmpl/debug.sgml

docs/reference/libnice/tmpl/ice.sgml

docs/reference/libnice/tmpl/interfaces.sgml

docs/reference/libnice/tmpl/pseudotcp.sgml

docs/reference/libnice/tmpl/stunagent.sgml

docs/reference/libnice/tmpl/stunmessage.sgml

docs/reference/libnice/tmpl/timer.sgml

docs/reference/libnice/tmpl/turn.sgml

gst/Makefile.in

gtk-doc.make

ltmain.sh

nice/Makefile.in

nice/libnice.sym

random/Makefile.in

socket/Makefile.in

socket/tcp-bsd.c

socket/tcp-turn.c

socket/turn.c

socket/turn.h

socket/udp-bsd.c

stun/Makefile.in

stun/stun5389.c

stun/stunagent.c

stun/stunagent.h

stun/stuncrc32.c

stun/stuncrc32.h

stun/stunmessage.c

stun/stunmessage.h

stun/tests/Makefile.in

stun/tests/test-parse.c

stun/tools/Makefile.in

stun/tools/stund.c

stun/usages/bind.c

stun/usages/ice.c

stun/usages/ice.h

stun/usages/timer.c

stun/usages/timer.h

stun/usages/turn.c

stun/usages/turn.h

tests/Makefile.in

tests/test-fullmode.c

Show diffs side-by-side

added added

removed removed

docs/reference/libnice/html/libnice-StunAgent.html

</head>

enum <a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a>;

enum <a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a>;

enum <a class="link" href="libnice-StunAgent.html#StunValidationStatus" title="enum StunValidationStatus">StunValidationStatus</a>;

bool (<a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">*StunMessageIntegrityValidate</a>) (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message,

uint8_t *username,

uint16_t username_len,

uint8_t **password,

size_t *password_len,

void *user_data);

bool (<a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">*StunMessageIntegrityValidate</a>) (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message</code>,

<code>uint8_t *username</code>,

<code>uint16_t username_len</code>,

<code>uint8_t **password</code>,

<code>size_t *password_len</code>,

<code>void *user_data</code>);

<a class="link" href="libnice-StunAgent.html#StunDefaultValidaterData" title="StunDefaultValidaterData">StunDefaultValidaterData</a>;

void <a class="link" href="libnice-StunAgent.html#stun-agent-init" title="stun_agent_init ()">stun_agent_init</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

const uint16_t *known_attributes,

<a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> compatibility,

<a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a> usage_flags);

<a class="link" href="libnice-StunAgent.html#StunValidationStatus" title="enum StunValidationStatus">StunValidationStatus</a> <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()">stun_agent_validate</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

const uint8_t *buffer,

size_t buffer_len,

<a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> validater,

void *validater_data);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-default-validater" title="stun_agent_default_validater ()">stun_agent_default_validater</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message,

uint8_t *username,

uint16_t username_len,

uint8_t **password,

size_t *password_len,

void *user_data);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-request" title="stun_agent_init_request ()">stun_agent_init_request</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

uint8_t *buffer,

size_t buffer_len,

<a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-indication" title="stun_agent_init_indication ()">stun_agent_init_indication</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

uint8_t *buffer,

size_t buffer_len,

<a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-response" title="stun_agent_init_response ()">stun_agent_init_response</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

uint8_t *buffer,

size_t buffer_len,

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-error" title="stun_agent_init_error ()">stun_agent_init_error</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

100

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

101

uint8_t *buffer,

102

size_t buffer_len,

103

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request,

104

<a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> err);

void <a class="link" href="libnice-StunAgent.html#stun-agent-init" title="stun_agent_init ()">stun_agent_init</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code>const uint16_t *known_attributes</code>,

<code><a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> compatibility</code>,

<code><a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a> usage_flags</code>);

<a class="link" href="libnice-StunAgent.html#StunValidationStatus" title="enum StunValidationStatus">StunValidationStatus</a> <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()">stun_agent_validate</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

<code>const uint8_t *buffer</code>,

<code>size_t buffer_len</code>,

<code><a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> validater</code>,

<code>void *validater_data</code>);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-default-validater" title="stun_agent_default_validater ()">stun_agent_default_validater</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message</code>,

<code>uint8_t *username</code>,

<code>uint16_t username_len</code>,

<code>uint8_t **password</code>,

<code>size_t *password_len</code>,

<code>void *user_data</code>);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-request" title="stun_agent_init_request ()">stun_agent_init_request</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

<code>uint8_t *buffer</code>,

<code>size_t buffer_len</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m</code>);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-indication" title="stun_agent_init_indication ()">stun_agent_init_indication</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

<code>uint8_t *buffer</code>,

<code>size_t buffer_len</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m</code>);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-response" title="stun_agent_init_response ()">stun_agent_init_response</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

<code>uint8_t *buffer</code>,

<code>size_t buffer_len</code>,

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>);

bool <a class="link" href="libnice-StunAgent.html#stun-agent-init-error" title="stun_agent_init_error ()">stun_agent_init_error</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

<code>uint8_t *buffer</code>,

<code>size_t buffer_len</code>,

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>,

<code><a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> err</code>);

105

size_t <a class="link" href="libnice-StunAgent.html#stun-agent-build-unknown-attributes-error" title="stun_agent_build_unknown_attributes_error ()">stun_agent_build_unknown_attributes_error</a>

106

(<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

107

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

108

uint8_t *buffer,

109

size_t buffer_len,

110

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request);

111

size_t <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()">stun_agent_finish_message</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

112

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

113

const uint8_t *key,

114

size_t key_len);

115

bool <a class="link" href="libnice-StunAgent.html#stun-agent-forget-transaction" title="stun_agent_forget_transaction ()">stun_agent_forget_transaction</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

116

<a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> id);

117

void <a class="link" href="libnice-StunAgent.html#stun-agent-set-software" title="stun_agent_set_software ()">stun_agent_set_software</a> (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

118

const char *software);

119

void <a class="link" href="libnice-StunAgent.html#stun-debug-enable" title="stun_debug_enable ()">stun_debug_enable</a> (void);

120

void <a class="link" href="libnice-StunAgent.html#stun-debug-disable" title="stun_debug_disable ()">stun_debug_disable</a> (void);

(<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

100

<code>uint8_t *buffer</code>,

101

<code>size_t buffer_len</code>,

102

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>);

103

size_t <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()">stun_agent_finish_message</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

104

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

105

<code>const uint8_t *key</code>,

106

<code>size_t key_len</code>);

107

bool <a class="link" href="libnice-StunAgent.html#stun-agent-forget-transaction" title="stun_agent_forget_transaction ()">stun_agent_forget_transaction</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

108

<code><a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> id</code>);

109

void <a class="link" href="libnice-StunAgent.html#stun-agent-set-software" title="stun_agent_set_software ()">stun_agent_set_software</a> (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

110

<code>const char *software</code>);

111

void <a class="link" href="libnice-StunAgent.html#stun-debug-enable" title="stun_debug_enable ()">stun_debug_enable</a> (<code>void</code>);

112

void <a class="link" href="libnice-StunAgent.html#stun-debug-disable" title="stun_debug_disable ()">stun_debug_disable</a> (<code>void</code>);

121

113

</pre>

122

114

</div>

123

115

127

119

It's main purpose is to make sure the building and validation methods used

128

120

are compatible with the RFC you create it with. It also tracks the transaction

129

121

ids of the requests you send, so you can validate if a STUN response you

130

received should be processed by that agent or not.

122

received should be processed by that agent or not.

123

131

124

</div>

132

125

133

126

<a name="libnice-StunAgent.details"></a><h2>Details</h2>

136

129

<pre class="programlisting">typedef struct stun_agent_t StunAgent;

137

130

</pre>

138

131

139

An opaque structure representing the STUN agent.

132

An opaque structure representing the STUN agent.

133

140

134

</div>

141

135

<hr>

142

136

145

139

STUN_COMPATIBILITY_RFC3489,

146

140

STUN_COMPATIBILITY_RFC5389,

147

141

STUN_COMPATIBILITY_WLM2009,

148

STUN_COMPATIBILITY_LAST = STUN_COMPATIBILITY_WLM2009

142

STUN_COMPATIBILITY_OC2007,

143

STUN_COMPATIBILITY_LAST = STUN_COMPATIBILITY_OC2007

149

144

} StunCompatibility;

150

145

</pre>

151

146

152

Enum that specifies the STUN compatibility mode of the <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

147

Enum that specifies the STUN compatibility mode of the <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

148

153

149

154

150

155

151

<tbody>

156

152

<tr>

157

153

<td><a name="STUN-COMPATIBILITY-RFC3489:CAPS"></a><code class="literal">STUN_COMPATIBILITY_RFC3489</code></td>

158

<td> Use the STUN specifications compatible with

154

<td>Use the STUN specifications compatible with

159

155

RFC 3489

160

156

</td>

161

157

</tr>

162

158

<tr>

163

159

<td><a name="STUN-COMPATIBILITY-RFC5389:CAPS"></a><code class="literal">STUN_COMPATIBILITY_RFC5389</code></td>

164

<td> Use the STUN specifications compatible with

160

<td>Use the STUN specifications compatible with

165

161

RFC 5389

166

162

</td>

167

163

</tr>

168

164

<tr>

169

165

<td><a name="STUN-COMPATIBILITY-WLM2009:CAPS"></a><code class="literal">STUN_COMPATIBILITY_WLM2009</code></td>

170

<td> Use the STUN specifications compatible with

166

<td>Use the STUN specifications compatible with

171

167

Windows Live Messenger 2009 (a mix between RFC3489 and RFC5389, as well as

172

168

a special usecase against a typo in their code)

173

169

</td>

174

170

</tr>

175

171

<tr>

172

<td><a name="STUN-COMPATIBILITY-OC2007:CAPS"></a><code class="literal">STUN_COMPATIBILITY_OC2007</code></td>

173

<td>Use the STUN specifications compatible with

174

Microsoft Office Communicator 2007 (basically RFC3489 with swapped

175

REALM and NONCE attribute hex IDs, attributes are not aligned)

176

</td>

177

</tr>

178

<tr>

176

179

<td><a name="STUN-COMPATIBILITY-LAST:CAPS"></a><code class="literal">STUN_COMPATIBILITY_LAST</code></td>

177

<td> Dummy last compatibility mode

180

<td>Dummy last compatibility mode

178

181

</td>

179

182

</tr>

180

183

</tbody>

191

194

STUN_AGENT_USAGE_IGNORE_CREDENTIALS = (1 << 4),

192

195

STUN_AGENT_USAGE_NO_INDICATION_AUTH = (1 << 5),

193

196

STUN_AGENT_USAGE_FORCE_VALIDATER = (1 << 6),

197

STUN_AGENT_USAGE_NO_ALIGNED_ATTRIBUTES = (1 << 7),

194

198

} StunAgentUsageFlags;

195

199

</pre>

196

200

201

205

202

206

203

207

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>

208

209

204

210

205

211

206

212

<tbody>

207

213

<tr>

208

214

<td><a name="STUN-AGENT-USAGE-SHORT-TERM-CREDENTIALS:CAPS"></a><code class="literal">STUN_AGENT_USAGE_SHORT_TERM_CREDENTIALS</code></td>

209

<td> The agent should be using the short

215

<td>The agent should be using the short

210

216

term credentials mechanism for authenticating STUN messages

211

217

</td>

212

218

</tr>

213

219

<tr>

214

220

<td><a name="STUN-AGENT-USAGE-LONG-TERM-CREDENTIALS:CAPS"></a><code class="literal">STUN_AGENT_USAGE_LONG_TERM_CREDENTIALS</code></td>

215

<td> The agent should be using the long

221

<td>The agent should be using the long

216

222

term credentials mechanism for authenticating STUN messages

217

223

</td>

218

224

</tr>

219

225

<tr>

220

226

<td><a name="STUN-AGENT-USAGE-USE-FINGERPRINT:CAPS"></a><code class="literal">STUN_AGENT_USAGE_USE_FINGERPRINT</code></td>

221

<td> The agent should add the FINGERPRINT

227

<td>The agent should add the FINGERPRINT

222

228

attribute to the STUN messages it creates.

223

229

</td>

224

230

</tr>

225

231

<tr>

226

232

<td><a name="STUN-AGENT-USAGE-ADD-SOFTWARE:CAPS"></a><code class="literal">STUN_AGENT_USAGE_ADD_SOFTWARE</code></td>

227

<td> The agent should add the SOFTWARE attribute

233

<td>The agent should add the SOFTWARE attribute

228

234

to the STUN messages it creates. Calling <a class="link" href="NiceAgent.html#nice-agent-set-software" title="nice_agent_set_software ()"><code class="function">nice_agent_set_software()</code></a> will have

229

235

the same effect as enabling this Usage. STUN Indications do not have the

230

236

SOFTWARE attributes added to them though. The SOFTWARE attribute is only

233

239

</tr>

234

240

<tr>

235

241

<td><a name="STUN-AGENT-USAGE-IGNORE-CREDENTIALS:CAPS"></a><code class="literal">STUN_AGENT_USAGE_IGNORE_CREDENTIALS</code></td>

236

<td> The agent should ignore any credentials

242

<td>The agent should ignore any credentials

237

243

in the STUN messages it receives (the MESSAGE-INTEGRITY attribute

238

244

will never be validated by <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>)

239

245

</td>

240

246

</tr>

241

247

<tr>

242

248

<td><a name="STUN-AGENT-USAGE-NO-INDICATION-AUTH:CAPS"></a><code class="literal">STUN_AGENT_USAGE_NO_INDICATION_AUTH</code></td>

243

<td> The agent should ignore credentials

249

<td>The agent should ignore credentials

244

250

in the STUN messages it receives if the <a class="link" href="libnice-StunMessage.html#StunClass" title="enum StunClass">StunClass</a> of the message is

245

251

<a class="link" href="libnice-StunMessage.html#STUN-INDICATION:CAPS">STUN_INDICATION</a> (some implementation require <a class="link" href="libnice-StunMessage.html#STUN-INDICATION:CAPS">STUN_INDICATION</a> messages to

246

252

be authenticated, while others never add a MESSAGE-INTEGRITY attribute to a

249

255

</tr>

250

256

<tr>

251

257

<td><a name="STUN-AGENT-USAGE-FORCE-VALIDATER:CAPS"></a><code class="literal">STUN_AGENT_USAGE_FORCE_VALIDATER</code></td>

252

<td> The agent should always try to validate

258

<td>The agent should always try to validate

253

259

the password of a STUN message, even if it already knows what the password

254

260

should be (a response to a previously created request). This means that the

255

261

<a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> callback will always be called when there is

256

262

a MESSAGE-INTEGRITY attribute.

257

263

</td>

258

264

</tr>

265

<tr>

266

<td><a name="STUN-AGENT-USAGE-NO-ALIGNED-ATTRIBUTES:CAPS"></a><code class="literal">STUN_AGENT_USAGE_NO_ALIGNED_ATTRIBUTES</code></td>

267

<td>The agent should not assume STUN

268

attributes are aligned on 32-bit boundaries when parsing messages and also

269

do not add padding when creating messages.

270

</td>

271

</tr>

259

272

</tbody>

260

273

</table></div>

261

274

</div>

276

289

</pre>

277

290

278

291

This enum is used as the return value of <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a> and represents

279

the status result of the validation of a STUN message.

292

the status result of the validation of a STUN message.

293

280

294

281

295

282

296

<tbody>

283

297

<tr>

284

298

<td><a name="STUN-VALIDATION-SUCCESS:CAPS"></a><code class="literal">STUN_VALIDATION_SUCCESS</code></td>

285

<td> The message is validated

299

<td>The message is validated

286

300

</td>

287

301

</tr>

288

302

<tr>

289

303

<td><a name="STUN-VALIDATION-NOT-STUN:CAPS"></a><code class="literal">STUN_VALIDATION_NOT_STUN</code></td>

290

<td> This is not a valid STUN message

304

<td>This is not a valid STUN message

291

305

</td>

292

306

</tr>

293

307

<tr>

294

308

<td><a name="STUN-VALIDATION-INCOMPLETE-STUN:CAPS"></a><code class="literal">STUN_VALIDATION_INCOMPLETE_STUN</code></td>

295

<td> The message seems to be valid but incomplete

309

<td>The message seems to be valid but incomplete

296

310

</td>

297

311

</tr>

298

312

<tr>

299

313

<td><a name="STUN-VALIDATION-BAD-REQUEST:CAPS"></a><code class="literal">STUN_VALIDATION_BAD_REQUEST</code></td>

300

<td> The message does not have the cookie or the

314

<td>The message does not have the cookie or the

301

315

fingerprint while the agent needs it with its usage

302

316

</td>

303

317

</tr>

304

318

<tr>

305

319

<td><a name="STUN-VALIDATION-UNAUTHORIZED-BAD-REQUEST:CAPS"></a><code class="literal">STUN_VALIDATION_UNAUTHORIZED_BAD_REQUEST</code></td>

306

<td> The message is valid but

320

<td>The message is valid but

307

321

unauthorized with no username and message-integrity attributes.

308

322

A BAD_REQUEST error must be generated

309

323

</td>

310

324

</tr>

311

325

<tr>

312

326

<td><a name="STUN-VALIDATION-UNAUTHORIZED:CAPS"></a><code class="literal">STUN_VALIDATION_UNAUTHORIZED</code></td>

313

<td> The message is valid but unauthorized as

327

<td>The message is valid but unauthorized as

314

328

the username/password do not match.

315

329

An UNAUTHORIZED error must be generated

316

330

</td>

317

331

</tr>

318

332

<tr>

319

333

<td><a name="STUN-VALIDATION-UNMATCHED-RESPONSE:CAPS"></a><code class="literal">STUN_VALIDATION_UNMATCHED_RESPONSE</code></td>

320

<td> The message is valid but this is a

334

<td>The message is valid but this is a

321

335

response/error that doesn't match a previously sent request

322

336

</td>

323

337

</tr>

324

338

<tr>

325

339

<td><a name="STUN-VALIDATION-UNKNOWN-REQUEST-ATTRIBUTE:CAPS"></a><code class="literal">STUN_VALIDATION_UNKNOWN_REQUEST_ATTRIBUTE</code></td>

326

<td> The message is valid but

340

<td>The message is valid but

327

341

contains one or more unknown comprehension attributes.

328

342

<a class="link" href="libnice-StunAgent.html#stun-agent-build-unknown-attributes-error" title="stun_agent_build_unknown_attributes_error ()"><code class="function">stun_agent_build_unknown_attributes_error()</code></a> should be called

329

343

</td>

330

344

</tr>

331

345

<tr>

332

346

<td><a name="STUN-VALIDATION-UNKNOWN-ATTRIBUTE:CAPS"></a><code class="literal">STUN_VALIDATION_UNKNOWN_ATTRIBUTE</code></td>

333

<td> The message is valid but contains one

347

<td>The message is valid but contains one

334

348

or more unknown comprehension attributes. This is a response, or error,

335

349

or indication message and no error response should be sent

336

350

</td>

341

355

<hr>

342

356

343

357

<a name="StunMessageIntegrityValidate"></a><h3>StunMessageIntegrityValidate ()</h3>

344

<pre class="programlisting">bool (*StunMessageIntegrityValidate) (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

345

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message,

346

uint8_t *username,

347

uint16_t username_len,

348

uint8_t **password,

349

size_t *password_len,

350

void *user_data);</pre>

358

<pre class="programlisting">bool (*StunMessageIntegrityValidate) (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

359

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message</code>,

360

<code>uint8_t *username</code>,

361

<code>uint16_t username_len</code>,

362

<code>uint8_t **password</code>,

363

<code>size_t *password_len</code>,

364

351

365

352

366

This is the prototype for the <code>validater</code> argument of the <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>

353

367

function.

354

368

355

369

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>

370

371

356

372

357

373

358

374

<tbody>

359

375

<tr>

360

376

<td><code>agent</code> :</td>

361

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

377

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

362

378

</td>

363

379

</tr>

364

380

<tr>

365

381

<td><code>message</code> :</td>

366

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> being validated

382

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> being validated

367

383

</td>

368

384

</tr>

369

385

<tr>

370

386

<td><code>username</code> :</td>

371

<td> The username found in the <code>message</code>

387

<td>The username found in the <code>message</code>

372

388

</td>

373

389

</tr>

374

390

<tr>

375

391

<td><code>username_len</code> :</td>

376

<td> The length of <code>username</code>

392

<td>The length of <code>username</code>

377

393

</td>

378

394

</tr>

379

395

<tr>

380

396

<td><code>password</code> :</td>

381

<td> The password associated with that username. This argument is a

397

<td>The password associated with that username. This argument is a

382

398

pointer to a byte array that must be set by the validater function.

383

399

</td>

384

400

</tr>

385

401

<tr>

386

402

<td><code>password_len</code> :</td>

387

<td> The length of <code>password</code> which must also be set by the

403

<td>The length of <code>password</code> which must also be set by the

388

404

validater function.

389

405

</td>

390

406

</tr>

391

407

<tr>

392

408

393

<td> Data to give the function

409

<td>Data to give the function

394

410

</td>

395

411

</tr>

396

412

<tr>

418

434

message during validationg.

419

435

420

436

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-default-validater" title="stun_agent_default_validater ()"><code class="function">stun_agent_default_validater()</code></a>

437

438

421

439

422

440

423

441

<tbody>

424

442

<tr>

425

443

<td>uint8_t *<code><a name="StunDefaultValidaterData.username"></a>username</code>;</td>

426

<td> The username

444

<td>The username

427

445

</td>

428

446

</tr>

429

447

<tr>

430

448

<td>size_t <code><a name="StunDefaultValidaterData.username-len"></a>username_len</code>;</td>

431

<td> The length of the <code>username</code>

449

<td>The length of the <code>username</code>

432

450

</td>

433

451

</tr>

434

452

<tr>

435

453

<td>uint8_t *<code><a name="StunDefaultValidaterData.password"></a>password</code>;</td>

436

<td> The password

454

<td>The password

437

455

</td>

438

456

</tr>

439

457

<tr>

440

458

<td>size_t <code><a name="StunDefaultValidaterData.password-len"></a>password_len</code>;</td>

441

<td> The length of the <code>password</code>

459

<td>The length of the <code>password</code>

442

460

</td>

443

461

</tr>

444

462

</tbody>

447

465

<hr>

448

466

449

467

<a name="stun-agent-init"></a><h3>stun_agent_init ()</h3>

450

<pre class="programlisting">void stun_agent_init (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

451

const uint16_t *known_attributes,

452

<a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> compatibility,

453

<a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a> usage_flags);</pre>

468

<pre class="programlisting">void stun_agent_init (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

469

<code>const uint16_t *known_attributes</code>,

470

<code><a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> compatibility</code>,

471

454

472

455

473

This function must be called to initialize an agent before it is being used.

456

474

472

490

<a class="link" href="libnice-StunAgent.html#STUN-COMPATIBILITY-WLM2009:CAPS">STUN_COMPATIBILITY_WLM2009</a> <code>compatibility</code> is used

473

491

474

492

</div>

493

494

475

495

476

496

477

497

<tbody>

478

498

<tr>

479

499

<td><code>agent</code> :</td>

480

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> to initialize

500

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> to initialize

481

501

</td>

482

502

</tr>

483

503

<tr>

484

504

<td><code>known_attributes</code> :</td>

485

<td> An array of uint16_t specifying which attributes should

505

<td>An array of uint16_t specifying which attributes should

486

506

be known by the agent. Any STUN message received that contains a mandatory

487

507

attribute that is not in this array will yield a

488

508

<a class="link" href="libnice-StunAgent.html#STUN-VALIDATION-UNKNOWN-REQUEST-ATTRIBUTE:CAPS">STUN_VALIDATION_UNKNOWN_REQUEST_ATTRIBUTE</a> or a

491

511

</tr>

492

512

<tr>

493

513

<td><code>compatibility</code> :</td>

494

<td> The <a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> to use for this agent. This will affect

514

<td>The <a class="link" href="libnice-StunAgent.html#StunCompatibility" title="enum StunCompatibility">StunCompatibility</a> to use for this agent. This will affect

495

515

how the agent builds and validates the STUN messages

496

516

</td>

497

517

</tr>

498

518

<tr>

499

519

<td><code>usage_flags</code> :</td>

500

<td> A bitflag using <a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a> values to define which

520

<td>A bitflag using <a class="link" href="libnice-StunAgent.html#StunAgentUsageFlags" title="enum StunAgentUsageFlags">StunAgentUsageFlags</a> values to define which

501

521

STUN usages the agent should use.

502

522

</td>

503

523

</tr>

507

527

<hr>

508

528

509

529

<a name="stun-agent-validate"></a><h3>stun_agent_validate ()</h3>

510

<pre class="programlisting"><a class="link" href="libnice-StunAgent.html#StunValidationStatus" title="enum StunValidationStatus">StunValidationStatus</a> stun_agent_validate (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

511

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

512

const uint8_t *buffer,

513

size_t buffer_len,

514

<a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> validater,

515

void *validater_data);</pre>

530

<pre class="programlisting"><a class="link" href="libnice-StunAgent.html#StunValidationStatus" title="enum StunValidationStatus">StunValidationStatus</a> stun_agent_validate (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

531

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

532

<code>const uint8_t *buffer</code>,

533

<code>size_t buffer_len</code>,

534

535

<code>void *validater_data</code>);</pre>

516

536

517

537

This function is used to validate an inbound STUN message and transform its

518

538

data buffer into a <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>. It will take care of various validation

520

540

authenticated.

521

541

522

542

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-default-validater" title="stun_agent_default_validater ()"><code class="function">stun_agent_default_validater()</code></a>

543

544

523

545

524

546

525

547

<tbody>

526

548

<tr>

527

549

<td><code>agent</code> :</td>

528

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

550

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

529

551

</td>

530

552

</tr>

531

553

<tr>

532

554

533

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

555

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

534

556

</td>

535

557

</tr>

536

558

<tr>

537

559

<td><code>buffer</code> :</td>

538

<td> The data buffer of the STUN message

560

<td>The data buffer of the STUN message

539

561

</td>

540

562

</tr>

541

563

<tr>

542

564

<td><code>buffer_len</code> :</td>

543

<td> The length of <code>buffer</code>

565

<td>The length of <code>buffer</code>

544

566

</td>

545

567

</tr>

546

568

<tr>

547

569

<td><code>validater</code> :</td>

548

<td> A <a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> function callback that will

570

<td>A <a class="link" href="libnice-StunAgent.html#StunMessageIntegrityValidate" title="StunMessageIntegrityValidate ()">StunMessageIntegrityValidate</a> function callback that will

549

571

be called if the agent needs to validate a MESSAGE-INTEGRITY attribute. It

550

572

will only be called if the agent finds a message that needs authentication

551

573

and a USERNAME is present in the STUN message, but no password is known.

556

578

</tr>

557

579

<tr>

558

580

<td><code>validater_data</code> :</td>

559

<td> A user data to give to the <code>validater</code> callback when it gets

581

<td>A user data to give to the <code>validater</code> callback when it gets

560

582

called.

561

583

</td>

562

584

</tr>

586

608

<hr>

587

609

588

610

<a name="stun-agent-default-validater"></a><h3>stun_agent_default_validater ()</h3>

589

<pre class="programlisting">bool stun_agent_default_validater (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

590

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message,

591

uint8_t *username,

592

uint16_t username_len,

593

uint8_t **password,

594

size_t *password_len,

595

void *user_data);</pre>

611

<pre class="programlisting">bool stun_agent_default_validater (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

612

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *message</code>,

613

<code>uint8_t *username</code>,

614

<code>uint16_t username_len</code>,

615

<code>uint8_t **password</code>,

616

<code>size_t *password_len</code>,

617

596

618

597

619

This is a helper function to be used with <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>. If no

598

620

complicated processing of the username needs to be done, this function can

602

624

password

603

625

604

626

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-validate" title="stun_agent_validate ()"><code class="function">stun_agent_validate()</code></a>

627

628

605

629

606

630

607

631

<tbody>

608

632

<tr>

609

633

<td><code>agent</code> :</td>

610

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

634

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

611

635

</td>

612

636

</tr>

613

637

<tr>

614

638

<td><code>message</code> :</td>

615

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> being validated

639

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> being validated

616

640

</td>

617

641

</tr>

618

642

<tr>

619

643

<td><code>username</code> :</td>

620

<td> The username found in the <code>message</code>

644

<td>The username found in the <code>message</code>

621

645

</td>

622

646

</tr>

623

647

<tr>

624

648

<td><code>username_len</code> :</td>

625

<td> The length of <code>username</code>

649

<td>The length of <code>username</code>

626

650

</td>

627

651

</tr>

628

652

<tr>

629

653

<td><code>password</code> :</td>

630

<td> The password associated with that username. This argument is a

654

<td>The password associated with that username. This argument is a

631

655

pointer to a byte array that must be set by the validater function.

632

656

</td>

633

657

</tr>

634

658

<tr>

635

659

<td><code>password_len</code> :</td>

636

<td> The length of <code>password</code> which must also be set by the

660

<td>The length of <code>password</code> which must also be set by the

637

661

validater function.

638

662

</td>

639

663

</tr>

640

664

<tr>

641

665

642

<td> This must be an array of <a class="link" href="libnice-StunAgent.html#StunDefaultValidaterData" title="StunDefaultValidaterData">StunDefaultValidaterData</a> structures.

666

<td>This must be an array of <a class="link" href="libnice-StunAgent.html#StunDefaultValidaterData" title="StunDefaultValidaterData">StunDefaultValidaterData</a> structures.

643

667

The last element in the array must have a username set to NULL

644

668

</td>

645

669

</tr>

655

679

<hr>

656

680

657

681

<a name="stun-agent-init-request"></a><h3>stun_agent_init_request ()</h3>

658

<pre class="programlisting">bool stun_agent_init_request (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

659

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

660

uint8_t *buffer,

661

size_t buffer_len,

662

<a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m);</pre>

682

<pre class="programlisting">bool stun_agent_init_request (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

683

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

684

<code>uint8_t *buffer</code>,

685

<code>size_t buffer_len</code>,

686

<code><a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m</code>);</pre>

663

687

664

Creates a new STUN message of class <a class="link" href="libnice-StunMessage.html#STUN-REQUEST:CAPS">STUN_REQUEST</a> and with the method <code>m</code>

688

689

665

690

666

691

667

692

<tbody>

668

693

<tr>

669

694

<td><code>agent</code> :</td>

670

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

695

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

671

696

</td>

672

697

</tr>

673

698

<tr>

674

699

675

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

700

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

676

701

</td>

677

702

</tr>

678

703

<tr>

679

704

<td><code>buffer</code> :</td>

680

<td> The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

705

<td>The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

681

706

</td>

682

707

</tr>

683

708

<tr>

684

709

<td><code>buffer_len</code> :</td>

685

<td> The length of the buffer

710

<td>The length of the buffer

686

711

</td>

687

712

</tr>

688

713

<tr>

689

714

690

<td> The <a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> of the request

715

<td>The <a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> of the request

691

716

</td>

692

717

</tr>

693

718

<tr>

701

726

<hr>

702

727

703

728

<a name="stun-agent-init-indication"></a><h3>stun_agent_init_indication ()</h3>

704

<pre class="programlisting">bool stun_agent_init_indication (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

705

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

706

uint8_t *buffer,

707

size_t buffer_len,

708

<a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m);</pre>

729

<pre class="programlisting">bool stun_agent_init_indication (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

730

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

731

<code>uint8_t *buffer</code>,

732

<code>size_t buffer_len</code>,

733

<code><a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> m</code>);</pre>

709

734

710

Creates a new STUN message of class <a class="link" href="libnice-StunMessage.html#STUN-INDICATION:CAPS">STUN_INDICATION</a> and with the method <code>m</code>

735

736

711

737

712

738

713

739

<tbody>

714

740

<tr>

715

741

<td><code>agent</code> :</td>

716

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

742

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

717

743

</td>

718

744

</tr>

719

745

<tr>

720

746

721

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

747

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

722

748

</td>

723

749

</tr>

724

750

<tr>

725

751

<td><code>buffer</code> :</td>

726

<td> The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

752

<td>The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

727

753

</td>

728

754

</tr>

729

755

<tr>

730

756

<td><code>buffer_len</code> :</td>

731

<td> The length of the buffer

757

<td>The length of the buffer

732

758

</td>

733

759

</tr>

734

760

<tr>

735

761

736

<td> The <a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> of the indication

762

<td>The <a class="link" href="libnice-StunMessage.html#StunMethod" title="enum StunMethod">StunMethod</a> of the indication

737

763

</td>

738

764

</tr>

739

765

<tr>

747

773

<hr>

748

774

749

775

<a name="stun-agent-init-response"></a><h3>stun_agent_init_response ()</h3>

750

<pre class="programlisting">bool stun_agent_init_response (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

751

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

752

uint8_t *buffer,

753

size_t buffer_len,

754

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request);</pre>

776

<pre class="programlisting">bool stun_agent_init_response (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

777

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

778

<code>uint8_t *buffer</code>,

779

<code>size_t buffer_len</code>,

780

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>);</pre>

755

781

756

782

Creates a new STUN message of class <a class="link" href="libnice-StunMessage.html#STUN-RESPONSE:CAPS">STUN_RESPONSE</a> and with the same method

757

783

and transaction ID as the message <code>request</code>. This will also copy the pointer

758

784

to the key that was used to authenticate the request, so you won't need to

759

specify the key with <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()"><code class="function">stun_agent_finish_message()</code></a>

785

specify the key with <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()"><code class="function">stun_agent_finish_message()</code></a>

786

760

787

761

788

762

789

<tbody>

763

790

<tr>

764

791

<td><code>agent</code> :</td>

765

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

792

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

766

793

</td>

767

794

</tr>

768

795

<tr>

769

796

770

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

797

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

771

798

</td>

772

799

</tr>

773

800

<tr>

774

801

<td><code>buffer</code> :</td>

775

<td> The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

802

<td>The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

776

803

</td>

777

804

</tr>

778

805

<tr>

779

806

<td><code>buffer_len</code> :</td>

780

<td> The length of the buffer

807

<td>The length of the buffer

781

808

</td>

782

809

</tr>

783

810

<tr>

784

811

<td><code>request</code> :</td>

785

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> of class <a class="link" href="libnice-StunMessage.html#STUN-REQUEST:CAPS">STUN_REQUEST</a> that this response is for

812

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> of class <a class="link" href="libnice-StunMessage.html#STUN-REQUEST:CAPS">STUN_REQUEST</a> that this response is for

786

813

</td>

787

814

</tr>

788

815

<tr>

796

823

<hr>

797

824

798

825

<a name="stun-agent-init-error"></a><h3>stun_agent_init_error ()</h3>

799

<pre class="programlisting">bool stun_agent_init_error (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

800

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

801

uint8_t *buffer,

802

size_t buffer_len,

803

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request,

804

<a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> err);</pre>

826

<pre class="programlisting">bool stun_agent_init_error (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

827

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

828

<code>uint8_t *buffer</code>,

829

<code>size_t buffer_len</code>,

830

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>,

831

<code><a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> err</code>);</pre>

805

832

806

833

Creates a new STUN message of class <a class="link" href="libnice-StunMessage.html#STUN-ERROR:CAPS">STUN_ERROR</a> and with the same method

807

834

and transaction ID as the message <code>request</code>. This will also copy the pointer

808

835

to the key that was used to authenticate the request (if authenticated),

809

836

so you won't need to specify the key with <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()"><code class="function">stun_agent_finish_message()</code></a>.

810

837

It will then add the ERROR-CODE attribute with code <code>err</code> and the associated

811

string.

838

string.

839

812

840

813

841

814

842

<tbody>

815

843

<tr>

816

844

<td><code>agent</code> :</td>

817

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

845

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

818

846

</td>

819

847

</tr>

820

848

<tr>

821

849

822

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

850

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

823

851

</td>

824

852

</tr>

825

853

<tr>

826

854

<td><code>buffer</code> :</td>

827

<td> The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

855

<td>The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

828

856

</td>

829

857

</tr>

830

858

<tr>

831

859

<td><code>buffer_len</code> :</td>

832

<td> The length of the buffer

860

<td>The length of the buffer

833

861

</td>

834

862

</tr>

835

863

<tr>

836

864

<td><code>request</code> :</td>

837

865

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> of class <a class="link" href="libnice-StunMessage.html#STUN-REQUEST:CAPS">STUN_REQUEST</a> that this error response

838

866

is for

839

867

</td>

840

868

</tr>

841

869

<tr>

842

870

843

<td> The <a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> to put in the ERROR-CODE attribute of the error response

871

<td>The <a class="link" href="libnice-StunMessage.html#StunError" title="enum StunError">StunError</a> to put in the ERROR-CODE attribute of the error response

844

872

</td>

845

873

</tr>

846

874

<tr>

855

883

856

884

<a name="stun-agent-build-unknown-attributes-error"></a><h3>stun_agent_build_unknown_attributes_error ()</h3>

857

885

<pre class="programlisting">size_t stun_agent_build_unknown_attributes_error

858

(<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

859

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

860

uint8_t *buffer,

861

size_t buffer_len,

862

const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request);</pre>

886

(<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

887

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

888

<code>uint8_t *buffer</code>,

889

<code>size_t buffer_len</code>,

890

<code>const <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *request</code>);</pre>

863

891

864

892

Creates a new STUN message of class <a class="link" href="libnice-StunMessage.html#STUN-ERROR:CAPS">STUN_ERROR</a> and with the same method

865

893

and transaction ID as the message <code>request</code>. It will then add the ERROR-CODE

866

894

attribute with code <a class="link" href="libnice-StunMessage.html#STUN-ERROR-UNKNOWN-ATTRIBUTE:CAPS">STUN_ERROR_UNKNOWN_ATTRIBUTE</a> and add all the unknown

867

895

mandatory attributes from the <code>request</code> STUN message in the

868

896

<a class="link" href="libnice-StunMessage.html#STUN-ATTRIBUTE-UNKNOWN-ATTRIBUTES:CAPS">STUN_ATTRIBUTE_UNKNOWN_ATTRIBUTES</a> attribute, it will then finish the message

869

by calling <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()"><code class="function">stun_agent_finish_message()</code></a>

897

by calling <a class="link" href="libnice-StunAgent.html#stun-agent-finish-message" title="stun_agent_finish_message ()"><code class="function">stun_agent_finish_message()</code></a>

898

870

899

871

900

872

901

<tbody>

873

902

<tr>

874

903

<td><code>agent</code> :</td>

875

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

904

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

876

905

</td>

877

906

</tr>

878

907

<tr>

879

908

880

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

909

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to build

881

910

</td>

882

911

</tr>

883

912

<tr>

884

913

<td><code>buffer</code> :</td>

885

<td> The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

914

<td>The buffer to use in the <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a>

886

915

</td>

887

916

</tr>

888

917

<tr>

889

918

<td><code>buffer_len</code> :</td>

890

<td> The length of the buffer

919

<td>The length of the buffer

891

920

</td>

892

921

</tr>

893

922

<tr>

894

923

<td><code>request</code> :</td>

895

924

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> of class <a class="link" href="libnice-StunMessage.html#STUN-REQUEST:CAPS">STUN_REQUEST</a> that this response is for

896

925

</td>

897

926

</tr>

898

927

<tr>

906

935

<hr>

907

936

908

937

<a name="stun-agent-finish-message"></a><h3>stun_agent_finish_message ()</h3>

909

<pre class="programlisting">size_t stun_agent_finish_message (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

910

<a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg,

911

const uint8_t *key,

912

size_t key_len);</pre>

938

<pre class="programlisting">size_t stun_agent_finish_message (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

939

<code><a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> *msg</code>,

940

<code>const uint8_t *key</code>,

941

913

942

914

943

This function will 'finish' a message and make it ready to be sent. It will

915

944

add the MESSAGE-INTEGRITY and FINGERPRINT attributes if necessary. If the

917

946

the message in the agent for future matching of the response.

918

947

919

948

See also: <a class="link" href="libnice-StunAgent.html#stun-agent-forget-transaction" title="stun_agent_forget_transaction ()"><code class="function">stun_agent_forget_transaction()</code></a>

949

950

920

951

921

952

922

953

<tbody>

923

954

<tr>

924

955

<td><code>agent</code> :</td>

925

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

956

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

926

957

</td>

927

958

</tr>

928

959

<tr>

929

960

930

<td> The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to finish

961

<td>The <a class="link" href="libnice-StunMessage.html#StunMessage" title="StunMessage">StunMessage</a> to finish

931

962

</td>

932

963

</tr>

933

964

<tr>

934

965

935

<td> The key to use for the MESSAGE-INTEGRITY attribute

966

<td>The key to use for the MESSAGE-INTEGRITY attribute

936

967

</td>

937

968

</tr>

938

969

<tr>

939

970

940

<td> The length of the <code>key</code>

971

<td>The length of the <code>key</code>

941

972

</td>

942

973

</tr>

943

974

<tr>

967

998

<hr>

968

999

969

1000

<a name="stun-agent-forget-transaction"></a><h3>stun_agent_forget_transaction ()</h3>

970

<pre class="programlisting">bool stun_agent_forget_transaction (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

971

<a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> id);</pre>

1001

<pre class="programlisting">bool stun_agent_forget_transaction (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

1002

<code><a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> id</code>);</pre>

972

1003

973

1004

This function is used to make the <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> forget about a previously

974

1005

created transaction.

981

1012

this will allow the <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> to forget about the timed out transaction and

982

1013

free its slot for future transactions.

983

1014

1015

1016

984

1017

985

1018

986

1019

<tbody>

987

1020

<tr>

988

1021

<td><code>agent</code> :</td>

989

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

1022

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

990

1023

</td>

991

1024

</tr>

992

1025

<tr>

993

1026

994

<td> The <a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> of the transaction to forget

1027

<td>The <a class="link" href="libnice-StunMessage.html#StunTransactionId" title="StunTransactionId">StunTransactionId</a> of the transaction to forget

995

1028

</td>

996

1029

</tr>

997

1030

<tr>

1006

1039

<hr>

1007

1040

1008

1041

<a name="stun-agent-set-software"></a><h3>stun_agent_set_software ()</h3>

1009

<pre class="programlisting">void stun_agent_set_software (<a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent,

1010

const char *software);</pre>

1042

<pre class="programlisting">void stun_agent_set_software (<code><a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a> *agent</code>,

1043

<code>const char *software</code>);</pre>

1011

1044

1012

1045

This function will set the value of the SOFTWARE attribute to be added to

1013

1046

STUN requests, responses and error responses.

1033

1066

the StunAgent's life. Do not free its content.

1034

1067

1035

1068

</div>

1069

1070

1036

1071

1037

1072

1038

1073

<tbody>

1039

1074

<tr>

1040

1075

<td><code>agent</code> :</td>

1041

<td> The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

1076

<td>The <a class="link" href="libnice-StunAgent.html#StunAgent" title="StunAgent">StunAgent</a>

1042

1077

</td>

1043

1078

</tr>

1044

1079

<tr>

1045

1080

<td><code>software</code> :</td>

1046

<td> The value of the SOFTWARE attribute to add.

1081

<td>The value of the SOFTWARE attribute to add.

1047

1082

</td>

1048

1083

</tr>

1049

1084

</tbody>

1053

1088

<hr>

1054

1089

1055

1090

<a name="stun-debug-enable"></a><h3>stun_debug_enable ()</h3>

1056

<pre class="programlisting">void stun_debug_enable (void);</pre>

1091

<pre class="programlisting">void stun_debug_enable (<code>void</code>);</pre>

1057

1092

1058

Enable debug messages to stderr

1093

Enable debug messages to stderr

1094

1059

1095

</div>

1060

1096

<hr>

1061

1097

1062

1098

<a name="stun-debug-disable"></a><h3>stun_debug_disable ()</h3>

1063

<pre class="programlisting">void stun_debug_disable (void);</pre>

1099

<pre class="programlisting">void stun_debug_disable (<code>void</code>);</pre>

1064

1100

1065

Disable debug messages to stderr

1101

Disable debug messages to stderr

1102

1066

1103

</div>

1067

1104

</div>

1068

1105

1072

1109

</div>

1073

1110

1074

1111

<hr>

1075

Generated by GTK-Doc V1.13</div>

1112

Generated by GTK-Doc V1.15</div>

1076

1113

</body>

1077

1114

</html>

b'\\ No newline at end of file'

Older »