syvita / solitude

I2P SAMv3 library in Rust (WIP)

SOLITUDE (WIP)

i2p SAMv3 library written in Rust for use in the EVA project.

Examples

Datagram Server

Creates a datagram service that logs whatever is sent to it.

cargo run --example datagram_server

Datagram client

Sends a datagram with the payload "Hello World! "to the supplied server

cargo run --example datagram_client <server_name>

Stream Server

Creates a Stream style server that logs whatever is sent to it.

cargo run --example stream_server

Stream Client

Sends "Hello World!" to the supplied server

cargo run --example stream_client <server_name>

solitude's Issues

Pref: Create benchmarking example

Program hangs if SAM server doesn't respond to a command.

Session::command() will await a response forever and cause the thread to hang. Needs a timeout method.

Unhelpful errors I2Pd/I2PRouter isn't running

Currently when you attempt to create a session without I2Pd/I2PRouter running, the library hangs.

Examples: Sessions stay open even after programs exit

TODO: implement scopeguard

Library hangs if SAMv3 doesn't add a newline to it's replies

If RESULT is not OK, SAM closes the connection without adding a newline byte. The library hangs when this happens. I believe this is caused by the line self.reader.read_line(&mut response)?. it doesn't find a \n byte so it keeps waiting until it finds one.

Add LICENSE

subj

Add other session styles (Raw and Stream)

Stream will be important for most communication between eva nodes, as raw and datagrams can fail and don't have any corrective measures to fix this. Datagrams would be useful to have, although for our voice chat implementation we'd probably want to use Raw format with a custom return field to save bandwidth.

Stream client/server examples working?

Do you currently consider the stream examples to be working? I tried to execute them using i2pd as backend router, but the router always fails with the error messages:

error - SAM: Read error: End of file
error - SAM: Stream read error: Operation canceled

I tried inserting a newline or nullbyte at the end of the "Hello World!" test text, but that did not help. So either my setup is somehow faulty, or there may be an issue in the usage of Rust's TcpStream or such (?)

Test: Create Action for Linux/MacOS.

Add config

Adding a struct for config stuff such as timeout for the stream and session style.