Crate rust_tcp_ipc

source ·
Expand description

This is a crate for Interprocess Communication via TCP.

It allows for easy, asynchronous sending and receiving messages/commands.

A flexible protocol is used, consisting of a command, a length and a payload.

In detail, it is expected that the used TCP protocol works via exchange of byte collections. A fixed header length is assumed, so - for example - the first 5 bytes of each message encode the message header. The header in turn consists of a command (like Stop, Start, Pause, Load, …) and a length part. Command & length can be in arbitrary order (but have to be fixed for the protocol). Then the next length-many bytes which are received are the payload of the message. Further received bytes form the next message.

An example is given in the Examples.

Macros

debug
Logs a message at the debug level.
error
Logs a message at the error level.
info
Logs a message at the info level.
log
The standard logging macro.
log_enabled
Determines if a message logged at the specified level in that module will be logged.
trace
Logs a message at the trace level.
warn
Logs a message at the warn level.

Structs

Client
This is the main type of the library. Here all the logic is bundle. It can be used to easily send and receive messages via TCP, allowing for many different protcols to be used.
ClientConfig
This bundles the time-settings for the protocol
Metadata
Metadata about a log message.
MetadataBuilder
Builder for Metadata.
ParseLevelError
The type returned by from_str when the string doesn’t match any of the log levels.
ProtocolBuffer
Record
The “payload” of a log message.
RecordBuilder
Builder for Record.
SetLoggerError
The type returned by set_logger if set_logger has already been called.
ShutdownError
The error type for a shutdown attemp.
TcpListener
A TCP socket server, listening for connections.
TcpStream
A TCP stream between a local and a remote socket.

Enums

BusyStateUpdateResult
The error type for a BusyState update
ConnectErrors
The error type for the connect-function.
Level
An enum representing the available verbosity levels of the logger.
LevelFilter
An enum representing the available verbosity level filters of the logger.
ParseHeaderError
The error type for parsing a header which was transferred via TCP.
ReadThreadErrors
TryRecvError
This enumeration is the list of the possible reasons that try_recv could not return data when called. This can occur with both a channel and a sync_channel.
WriteMessageErrors

Constants

STATIC_MAX_LEVEL
The statically resolved maximum log level.

Traits

Log
A trait encapsulating the operations required of a logger.
Protocol
This trait represents the TCP-Protocol to be used.
Read
The Read trait allows for reading bytes from a source.
ToSocketAddrs
A trait for objects which can be converted or resolved to one or more SocketAddr values.
Write
A trait for objects which are byte-oriented sinks.

Functions

logger
Returns a reference to the logger.
max_level
Returns the current maximum log level.
set_boxed_logger
Sets the global logger to a Box<Log>.
set_logger
Sets the global logger to a &'static Log.
set_logger_racy⚠
A thread-unsafe version of set_logger.
set_max_level
Sets the global maximum log level.

Type Definitions

Message
A type alias combining a command (as enum-variant) & a message (as byte-vector).