GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add notice re sdks (#5792)

Browse Source 
* add notice re sdks

* fix borked notice

* fix another borked notice
This commit is contained in:
mfahampshire
2025-05-22 12:25:25 +02:00
committed by GitHub
parent 39195d79f5
commit a0057eb223
50 changed files with 424 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/pages/developers/rust/tcpproxy/examples/multiconn.mdx
+8
View File
@@ -1,5 +1,13 @@
# Multi Connection Example
import { Callout } from 'nextra/components'
<Callout type="warning">
There will be a breaking SDK upgrade in the coming months. This upgrade will make the SDK a lot easier to build with.
This upgrade will affect the interface of the SDK dramatically, and will be coupled with a protocol change - stay tuned for information on early access to the new protocol testnet.
It will also be coupled with the documentation of the SDK on [crates.io](https://crates.io/).
</Callout>
This example starts off several Tcp connections on a loop to a remote endpoint: in this case the `TcpListener` behind the `NymProxyServer` instance on the echo server found in
[`nym/tools/echo-server/`](https://github.com/nymtech/nym/tree/develop/tools/echo-server). It pipes a few messages to it, logs the replies, and keeps track of the number of replies received per connection.
documentation/docs/pages/developers/rust/tcpproxy/examples/singleconn.mdx
+8
View File
@@ -1,5 +1,13 @@
# Single Connection Example
import { Callout } from 'nextra/components'
<Callout type="warning">
There will be a breaking SDK upgrade in the coming months. This upgrade will make the SDK a lot easier to build with.
This upgrade will affect the interface of the SDK dramatically, and will be coupled with a protocol change - stay tuned for information on early access to the new protocol testnet.
It will also be coupled with the documentation of the SDK on [crates.io](https://crates.io/).
</Callout>
This is a basic example which opens a single TCP connection and writes a bunch of messages between a client and some 'echo server' logic, so only uses a single session under the hood and doesn't really show off the message ordering capabilities; this is mainly just a quick introductory illustration on how:
- the mixnet does message ordering
- the NymProxyClient and NymProxyServer can be hooked into and used to communicate between two otherwise pretty vanilla TcpStreams