Skip to content

Commit 98ece32

Browse files
sipsorcerysipsorcery
committed
Appveyor CI updates
1 parent c1fc634 commit 98ece32

File tree

2 files changed

+34
-30
lines changed

2 files changed

+34
-30
lines changed

‎api/SIPSorcery.Net.STUNAddressAttribute.html

+33-29
Original file line numberDiff line numberDiff line change
@@ -149,31 +149,30 @@ <h6><strong>Namespace</strong>: <a class="xref" href="SIPSorcery.Net.html">SIPSo
149149
<h6><strong>Assembly</strong>: SIPSorcery.dll</h6>
150150
<h5 id="SIPSorcery_Net_STUNAddressAttribute_syntax">Syntax</h5>
151151
<div class="codewrapper">
152-
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Provided for backward compatibility with RFC3489 clients.&quot;)]
153-
public class STUNAddressAttribute : STUNAddressAttributeBase</code></pre>
152+
<pre><code class="lang-csharp hljs">public class STUNAddressAttribute : STUNAddressAttributeBase</code></pre>
154153
</div>
154+
<h5 id="SIPSorcery_Net_STUNAddressAttribute_remarks"><strong>Remarks</strong></h5>
155+
<div class="markdown level0 remarks"><p>There's no proper explanation of why this STUN attribute was obsoleted. My guess is to favour using the XOR Maoped Address attribute
156+
BUT that does not help when a STUN server provides this atype of address attribute. It will still need to be parsed and understood,
157+
Reverted this obsoletion on 13 Nov 2024 AC.</p>
158+
</div>
155159
<h3 id="constructors">Constructors
156160
</h3>
157161
<span class="small pull-right mobile-hide">
158162
<span class="divider">|</span>
159163
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte___.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute.%23ctor(SIPSorcery.Net.STUNAttributeTypesEnum%2CSystem.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
160164
</span>
161165
<span class="small pull-right mobile-hide">
162-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L55">View Source</a>
166+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L63">View Source</a>
163167
</span>
164168
<a id="SIPSorcery_Net_STUNAddressAttribute__ctor_" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor*"></a>
165169
<h4 id="SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte___" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor(SIPSorcery.Net.STUNAttributeTypesEnum,System.Byte[])">STUNAddressAttribute(STUNAttributeTypesEnum, Byte[])</h4>
166-
<div class="markdown level1 summary"><p>Obsolete.
167-
<br> For IPv6 support, please parse using
168-
<br> <a class="xref" href="SIPSorcery.Net.STUNXORAddressAttribute.html#SIPSorcery_Net_STUNXORAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte___System_Byte___">STUNXORAddressAttribute(STUNAttributeTypesEnum, Byte[], Byte[])</a>
169-
<br> <br>
170-
Parses an IPv4 Address attribute.</p>
170+
<div class="markdown level1 summary"><p>Parses an IPv4 Address attribute.</p>
171171
</div>
172172
<div class="markdown level1 conceptual"></div>
173173
<h5 class="decalaration">Declaration</h5>
174174
<div class="codewrapper">
175-
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Provided for backward compatibility with RFC3489 clients.&quot;)]
176-
public STUNAddressAttribute(STUNAttributeTypesEnum attributeType, byte[] attributeValue)</code></pre>
175+
<pre><code class="lang-csharp hljs">public STUNAddressAttribute(STUNAttributeTypesEnum attributeType, byte[] attributeValue)</code></pre>
177176
</div>
178177
<h5 class="parameters">Parameters</h5>
179178
<table class="table table-bordered table-striped table-condensed">
@@ -197,26 +196,26 @@ <h5 class="parameters">Parameters</h5>
197196
</tr>
198197
</tbody>
199198
</table>
199+
<h5 id="SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte____remarks">Remarks</h5>
200+
<div class="markdown level1 remarks"><p>There's no proper explanation of why this STUN attribute was obsoleted. My guess is to favour using the XOR Maoped Address attribute
201+
BUT that does not help when a STUN server provides this atype of address attribute. It will still need to be parsed and understood,
202+
Reverted this obsoletion on 13 Nov 2024 AC.</p>
203+
</div>
200204
<span class="small pull-right mobile-hide">
201205
<span class="divider">|</span>
202206
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Int32_System_Net_IPAddress_.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute.%23ctor(SIPSorcery.Net.STUNAttributeTypesEnum%2CSystem.Int32%2CSystem.Net.IPAddress)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
203207
</span>
204208
<span class="small pull-right mobile-hide">
205-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L78">View Source</a>
209+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L87">View Source</a>
206210
</span>
207211
<a id="SIPSorcery_Net_STUNAddressAttribute__ctor_" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor*"></a>
208212
<h4 id="SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Int32_System_Net_IPAddress_" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor(SIPSorcery.Net.STUNAttributeTypesEnum,System.Int32,System.Net.IPAddress)">STUNAddressAttribute(STUNAttributeTypesEnum, Int32, IPAddress)</h4>
209-
<div class="markdown level1 summary"><p>Obsolete.
210-
<br> For IPv6 support, please parse using
211-
<br> <a class="xref" href="SIPSorcery.Net.STUNXORAddressAttribute.html#SIPSorcery_Net_STUNXORAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte___System_Byte___">STUNXORAddressAttribute(STUNAttributeTypesEnum, Byte[], Byte[])</a>
212-
<br> <br>
213-
Parses an IPv4 Address attribute.</p>
213+
<div class="markdown level1 summary"><p>Parses an IPv4 Address attribute.</p>
214214
</div>
215215
<div class="markdown level1 conceptual"></div>
216216
<h5 class="decalaration">Declaration</h5>
217217
<div class="codewrapper">
218-
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Provided for backward compatibility with RFC3489 clients.&quot;)]
219-
public STUNAddressAttribute(STUNAttributeTypesEnum attributeType, int port, IPAddress address)</code></pre>
218+
<pre><code class="lang-csharp hljs">public STUNAddressAttribute(STUNAttributeTypesEnum attributeType, int port, IPAddress address)</code></pre>
220219
</div>
221220
<h5 class="parameters">Parameters</h5>
222221
<table class="table table-bordered table-striped table-condensed">
@@ -245,26 +244,26 @@ <h5 class="parameters">Parameters</h5>
245244
</tr>
246245
</tbody>
247246
</table>
247+
<h5 id="SIPSorcery_Net_STUNAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Int32_System_Net_IPAddress__remarks">Remarks</h5>
248+
<div class="markdown level1 remarks"><p>There's no proper explanation of why this STUN attribute was obsoleted. My guess is to favour using the XOR Maoped Address attribute
249+
BUT that does not help when a STUN server provides this atype of address attribute. It will still need to be parsed and understood,
250+
Reverted this obsoletion on 13 Nov 2024 AC.</p>
251+
</div>
248252
<span class="small pull-right mobile-hide">
249253
<span class="divider">|</span>
250254
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute__ctor_System_Byte___.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute.%23ctor(System.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
251255
</span>
252256
<span class="small pull-right mobile-hide">
253-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L32">View Source</a>
257+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L39">View Source</a>
254258
</span>
255259
<a id="SIPSorcery_Net_STUNAddressAttribute__ctor_" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor*"></a>
256260
<h4 id="SIPSorcery_Net_STUNAddressAttribute__ctor_System_Byte___" data-uid="SIPSorcery.Net.STUNAddressAttribute.#ctor(System.Byte[])">STUNAddressAttribute(Byte[])</h4>
257-
<div class="markdown level1 summary"><p>Obsolete.
258-
<br> For IPv6 support, please parse using
259-
<br> <a class="xref" href="SIPSorcery.Net.STUNXORAddressAttribute.html#SIPSorcery_Net_STUNXORAddressAttribute__ctor_SIPSorcery_Net_STUNAttributeTypesEnum_System_Byte___System_Byte___">STUNXORAddressAttribute(STUNAttributeTypesEnum, Byte[], Byte[])</a>
260-
<br> <br>
261-
Parses an IPv4 Address attribute.</p>
261+
<div class="markdown level1 summary"><p>Parses an IPv4 Address attribute.</p>
262262
</div>
263263
<div class="markdown level1 conceptual"></div>
264264
<h5 class="decalaration">Declaration</h5>
265265
<div class="codewrapper">
266-
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Provided for backward compatibility with RFC3489 clients.&quot;)]
267-
public STUNAddressAttribute(byte[] attributeValue)</code></pre>
266+
<pre><code class="lang-csharp hljs">public STUNAddressAttribute(byte[] attributeValue)</code></pre>
268267
</div>
269268
<h5 class="parameters">Parameters</h5>
270269
<table class="table table-bordered table-striped table-condensed">
@@ -283,14 +282,19 @@ <h5 class="parameters">Parameters</h5>
283282
</tr>
284283
</tbody>
285284
</table>
285+
<h5 id="SIPSorcery_Net_STUNAddressAttribute__ctor_System_Byte____remarks">Remarks</h5>
286+
<div class="markdown level1 remarks"><p>There's no proper explanation of why this STUN attribute was obsoleted. My guess is to favour using the XOR Maoped Address attribute
287+
BUT that does not help when a STUN server provides this atype of address attribute. It will still need to be parsed and understood,
288+
Reverted this obsoletion on 13 Nov 2024 AC.</p>
289+
</div>
286290
<h3 id="methods">Methods
287291
</h3>
288292
<span class="small pull-right mobile-hide">
289293
<span class="divider">|</span>
290294
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute_ToByteBuffer_System_Byte___System_Int32_.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute.ToByteBuffer(System.Byte%5B%5D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
291295
</span>
292296
<span class="small pull-right mobile-hide">
293-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L89">View Source</a>
297+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L97">View Source</a>
294298
</span>
295299
<a id="SIPSorcery_Net_STUNAddressAttribute_ToByteBuffer_" data-uid="SIPSorcery.Net.STUNAddressAttribute.ToByteBuffer*"></a>
296300
<h4 id="SIPSorcery_Net_STUNAddressAttribute_ToByteBuffer_System_Byte___System_Int32_" data-uid="SIPSorcery.Net.STUNAddressAttribute.ToByteBuffer(System.Byte[],System.Int32)">ToByteBuffer(Byte[], Int32)</h4>
@@ -344,7 +348,7 @@ <h5 class="overrides">Overrides</h5>
344348
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute_ToString.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
345349
</span>
346350
<span class="small pull-right mobile-hide">
347-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L117">View Source</a>
351+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L125">View Source</a>
348352
</span>
349353
<a id="SIPSorcery_Net_STUNAddressAttribute_ToString_" data-uid="SIPSorcery.Net.STUNAddressAttribute.ToString*"></a>
350354
<h4 id="SIPSorcery_Net_STUNAddressAttribute_ToString" data-uid="SIPSorcery.Net.STUNAddressAttribute.ToString">ToString()</h4>
@@ -386,7 +390,7 @@ <h3 id="extensionmethods">Extension Methods</h3>
386390
<a href="https://github.com/sipsorcery-org/sipsorcery/new/gh-pages/apiSpec/new?filename=SIPSorcery_Net_STUNAddressAttribute.md&amp;value=---%0Auid%3A%20SIPSorcery.Net.STUNAddressAttribute%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
387391
</li>
388392
<li>
389-
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L22" class="contribution-link">View Source</a>
393+
<a href="https://github.com/sipsorcery-org/sipsorcery/blob/gh-pages/src/net/STUN/STUNAttributes/STUNAddressAttribute.cs/#L28" class="contribution-link">View Source</a>
390394
</li>
391395
</ul>
392396
</div>

‎manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1929,7 +1929,7 @@
19291929
"output": {
19301930
".html": {
19311931
"relative_path": "api/SIPSorcery.Net.STUNAddressAttribute.html",
1932-
"hash": "E2kCmJtHR0zT4BQTG68UTMGuMCi1jl3nOh9GQut1jB0="
1932+
"hash": "xFO2q3sThkuebrfQWjfP+Hkbyk9Nin6J5bpRN27uJ8c="
19331933
}
19341934
},
19351935
"is_incremental": false,

0 commit comments

Comments
 (0)