Skip to content

Commit

Permalink
Generate Pelican site
Browse files Browse the repository at this point in the history
  • Loading branch information
paullouisageneau committed Oct 22, 2023
1 parent 566f6f1 commit 55dd4bd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
2 changes: 1 addition & 1 deletion feeds/all.atom.xml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"><title>libdatachannel</title><link href="https://libdatachannel.org/" rel="alternate"></link><link href="https://libdatachannel.org/feeds/all.atom.xml" rel="self"></link><id>https://libdatachannel.org/</id><updated>2023-05-11T11:26:10Z</updated><subtitle></subtitle></feed>
<feed xmlns="http://www.w3.org/2005/Atom"><title>libdatachannel</title><link href="https://libdatachannel.org/" rel="alternate"></link><link href="https://libdatachannel.org/feeds/all.atom.xml" rel="self"></link><id>https://libdatachannel.org/</id><updated>2023-10-22T21:12:31Z</updated></feed>
26 changes: 23 additions & 3 deletions pages/reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h4>rtcCreatePeerConnection</h4>
<li><code>disableAutoNegotiation</code>: if true, the user is responsible for calling <code>rtcSetLocalDescription</code> after creating a Data Channel and after setting the remote description</li>
<li><code>forceMediaTransport</code>: if true, the connection allocates the SRTP media transport even if no tracks are present (necessary to add tracks during later renegotiation)</li>
<li><code>portRangeBegin</code> (optional): first port (included) of the allowed local port range (0 if unused)</li>
<li><code>portRangeEnd</code> (optional): last port (included) of the allowed local port (0 if unused)</li>
<li><code>portRangeEnd</code> (optional): last port (included) of the allowed local port range (0 if unused)</li>
<li><code>mtu</code> (optional): manually set the Maximum Transfer Unit (MTU) for the connection (0 if automatic)</li>
<li><code>maxMessageSize</code> (optional): manually set the local maximum message size for Data Channels (0 if default)</li>
</ul>
Expand Down Expand Up @@ -279,6 +279,14 @@ <h4>rtcGetMaxDataChannelStream</h4>
<p>Arguments:
- <code>pc</code>: the Peer Connection identifier</p>
<p>Return value: the maximum stream ID (<code>stream</code> for a Data Channel may be set from 0 to this value included) or a negative error code</p>
<h4>rtcGetRemoteMaxMessageSize</h4>
<p><code>int rtcGetRemoteMaxMessageSize(int pc)</code></p>
<p>Retrieves the maximum message size for data channels on the peer connection as negotiated with the remote peer.</p>
<p>Arguments:</p>
<ul>
<li><code>pc</code>: the Peer Connection identifier</li>
</ul>
<p>Return value: the maximum message size for data channels or a negative error code</p>
<h3>Channel (Common API for Data Channel, Track, and WebSocket)</h3>
<p>The following common functions might be called with a generic channel identifier. It may be the identifier of either a Data Channel, a Track, or a WebSocket.</p>
<h4>rtcSetXCallback</h4>
Expand Down Expand Up @@ -347,6 +355,14 @@ <h4>rtcIsClosed</h4>
<li><code>id</code>: the channel identifier</li>
</ul>
<p>Return value: <code>true</code> if the channel exists and is closed (not open and not connecting), <code>false</code> otherwise</p>
<h4>rtcGetMaxMessageSize</h4>
<p><code>int rtcGetMaxMessageSize(int id)</code></p>
<p>Retrieves the maximum message size for the channel.</p>
<p>Arguments:</p>
<ul>
<li><code>id</code>: the channel identifier</li>
</ul>
<p>Return value: the maximum message size or a negative error code</p>
<h4>rtcGetBufferedAmount</h4>
<p><code>int rtcGetBufferedAmount(int id)</code></p>
<p>Retrieves the current buffered amount, i.e. the total size of currently buffered messages waiting to be actually sent in the channel. This does not account for the data buffered at the transport level.</p>
Expand Down Expand Up @@ -536,7 +552,8 @@ <h4>rtcCreateWebSocket</h4>
bool disableTlsVerification;
const char **protocols;
int protocolsCount;
int pingInterval;
int connectionTimeoutMs;
int pingIntervalMs;
int maxOutstandingPings;
} rtcWsConfiguration;
```</p>
Expand All @@ -548,7 +565,8 @@ <h4>rtcCreateWebSocket</h4>
<li><code>disableTlsVerification</code>: if true, don't verify the TLS certificate, else try to verify it if possible</li>
<li><code>protocols</code> (optional): an array of pointers on null-terminated protocol names (NULL if unused)</li>
<li><code>protocolsCount</code> (optional): number of URLs in the array pointed by <code>protocols</code> (0 if unused)</li>
<li><code>pingInterval</code> (optional): ping interval in milliseconds (0 if default, &lt; 0 if disabled)</li>
<li><code>connectionTimeoutMs</code> (optional): connection timeout in milliseconds (0 if default, &lt; 0 if disabled)</li>
<li><code>pingIntervalMs</code> (optional): ping interval in milliseconds (0 if default, &lt; 0 if disabled)</li>
<li><code>maxOutstandingPings</code> (optional): number of unanswered pings before declaring failure (0 if default, &lt; 0 if disabled)</li>
</ul>
</li>
Expand Down Expand Up @@ -594,6 +612,7 @@ <h4>rtcCreateWebSocketServer</h4>
const char <em>certificatePemFile;
const char </em>keyPemFile;
const char *keyPemPass;
int connectionTimeoutMs;
} rtcWsServerConfiguration;
```</p>
<p>Creates a new WebSocket server.</p>
Expand All @@ -605,6 +624,7 @@ <h4>rtcCreateWebSocketServer</h4>
<li><code>certificatePemFile</code> (optional): PEM certificate or path of the file containing the PEM certificate (<code>NULL</code> for an autogenerated certificate)</li>
<li><code>keyPemFile</code> (optional): PEM key or path of the file containing the PEM key (<code>NULL</code> for an autogenerated certificate)</li>
<li><code>keyPemPass</code> (optional): PEM key file passphrase (NULL if no passphrase)</li>
<li><code>connectionTimeoutMs</code> (optional): connection timeout in milliseconds (0 if default, &lt; 0 if disabled)</li>
</ul>
</li>
<li><code>cb</code>: the callback for incoming client WebSocket connections (must not be <code>NULL</code>)</li>
Expand Down

0 comments on commit 55dd4bd

Please sign in to comment.