From 54282fa09875e4fbd78a15fec482ef5fbe50537e Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Wed, 9 Oct 2024 14:59:22 +0200 Subject: [PATCH] finished ffi overview page --- documentation/docs/pages/developers/rust/ffi.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/documentation/docs/pages/developers/rust/ffi.mdx b/documentation/docs/pages/developers/rust/ffi.mdx index 33cdd16c0a..f82e8fb17c 100644 --- a/documentation/docs/pages/developers/rust/ffi.mdx +++ b/documentation/docs/pages/developers/rust/ffi.mdx @@ -3,7 +3,7 @@ import { Callout } from 'nextra/components' # FFI Bindings - We are only working on the intitial versions of the FFI code to allow developers to experiment and get feedback. Please get in touch if you think the FFI bindings are lacking certain functionality. + We are working on the intitial versions of the FFI code to allow developers to experiment and get feedback. Please get in touch if you think the FFI bindings are lacking certain functionality. We currently have FFI bindings for Go and C/C++. See the table below to check the coverage of functionality we expect devs would like to see. @@ -34,6 +34,12 @@ This is the basic mixnet component of the SDK, exposing client functionality wit > We have also implemented `listen_for_incoming_internal()` which is a wrapper around the Mixnet client's `wait_for_messages()`. This is a helper method for listening out for and handling incoming messages. +#### Currently Unsupported Functionality +At the time of writing the following functionality is not exposed to the shared FFI library: +- `split_sender()`: the ability to [split a client into sender and receiver](./mixnet/examples/split-send) for concurrent send/receive. +- The use of [custom network topologies](./mixnet/examples/custom-topology). +- `Socks5::new()`: creation and use of the [socks5/4a/4 proxy client](./mixnet/examples/socks). + ### TcpProxy Module A connection abstraction which exposes a local TCP socket which developers are able to interact with basically as expected, being able to read/write to/from a bytestream, without really having to take into account the workings of the Mixnet/Sphinx/the [message-based](../concepts/messages) format of the underlying client.