Struct Connection

pub struct Connection<P: ProtocolRW + Send> { /* private fields */ }

Represents a connection between a client and a server.

Implementations

impl<P: ProtocolRW + Send> Connection<P>

pub fn new( stream: TcpStream, packet_type: PacketType, in_keyfile: PrivateKey, out_keyfile: PublicKey, ) -> Self

Creates a new connection. in_keyfile is the RSA key to decrypt encryption request. out_keyfile is the RSA key to encrypt encryption request.

Note

If the provided stream is not set to a nonblocking mode then any read/write operation will block.

Panics

If tokio feature is enabled then this function will implicitly convert a stream to an async stream. This function panics if this conversion fails.

pub fn new_async( stream: TcpStream, packet_type: PacketType, in_keyfile: PrivateKey, out_keyfile: PublicKey, ) -> Self

Available on crate feature tokio only.

Creates a new connection. in_keyfile is the RSA key to decrypt encryption request. out_keyfile is the RSA key to encrypt encryption request.

pub fn get_ip(&self) -> Result<Ipv4Addr>

Returns the ip address of the client.

pub fn change_packet_type(&mut self, packet_type: PacketType)

Changes connection type.

pub fn into_split(self) -> Result<(ConnectionRead<P>, ConnectionWrite)>

Available on crate feature split_connection only.

Splits the connection into separate read and write components.

pub fn read_packet(&mut self) -> Result<P, ConnectionError>

Reads a packet from the stream.

Note

If tokio feature is enabled this function becomes nonblocking

pub async fn read_packet_async(&mut self) -> Result<P, ConnectionError>

Available on crate feature tokio only.

Reads a packet from the stream.

pub fn create_ppac<PT: AsRef<Path>>( &mut self, path: PT, direction: Direction, ) -> Result<(), ConnectionError>

Available on crate feature ppac only.

Creates a packet storage file. direction is the direction of the write side of the connection.

pub fn write_packet( &mut self, packet: &impl ProtocolRW, ) -> Result<(), ConnectionError>

Sends a packet.

Note

If tokio feature is enabled this function becomes nonblocking

pub async fn write_packet_async( &mut self, packet: &(impl ProtocolRW + Sync), ) -> Result<(), ConnectionError>

Available on crate feature tokio only.

Sends a packet.

pub fn get_key(&mut self) -> Vec<u8>

Returns the encryption key (for Packet::EncryptionResponse).

pub fn flush(&mut self) -> Result<()>

Writes all pending packets.

pub async fn flush_async(&mut self) -> Result<()>

Available on crate feature tokio only.

Writes all pending packets.

Trait Implementations

impl<P: Debug + ProtocolRW + Send> Debug for Connection<P>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.