Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
merklefruit committed Aug 25, 2024
1 parent f711e0a commit a79265d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion msg-transport/src/ipc/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ use msg_common::async_error;
#[derive(Debug, Default)]
pub struct Config;

/// An IPC (Inter-Process Communication) implementation using Unix domain sockets.
///
/// This struct represents the IPC transport, which allows communication between processes
/// on the same machine using Unix domain sockets.
///
/// # Features
/// - Asynchronous communication using Tokio's runtime
/// - Supports both connection-oriented (stream) and connectionless (datagram) sockets
/// - Implements standard transport traits for easy integration with other components
///
/// Note: This implementation is specific to Unix-like operating systems and is not tested
/// on Windows or other non-Unix platforms.
#[derive(Debug, Default)]
pub struct Ipc {
#[allow(unused)]
Expand Down Expand Up @@ -142,7 +154,7 @@ impl Transport for Ipc {
}
}

#[async_trait::async_trait]
#[async_trait]
impl TransportExt for Ipc {
fn accept(&mut self) -> Acceptor<'_, Self>
where
Expand Down

0 comments on commit a79265d

Please sign in to comment.