Struct SctpStream

pub struct SctpStream(/* private fields */);

One-to-one SCTP connected stream which behaves like a TCP stream. A SctpStream can be obtained either actively by connecting to a SCTP endpoint with the connect constructor, or passively from a SctpListener which accepts new connections

Implementations

impl SctpStream

pub fn connect<A: ToSocketAddrs>(address: A) -> Result<SctpStream>

Create a new stream by connecting it to a remote endpoint

Examples found in repository

examples/stream.rs (line 8)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn connectx<A: ToSocketAddrs>(addresses: &[A]) -> Result<SctpStream>

Create a new stream by connecting it to a remote endpoint having multiple addresses

pub fn sendmsg(&self, msg: &[u8], stream: u16) -> Result<usize>

Send bytes on the specified SCTP stream. On success, returns the quantity of bytes read

Examples found in repository

examples/listener.rs (line 19)

fn main() {
    match SctpListener::bind("0.0.0.0:3868") {
        //	match SctpListener::bindx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Ok(serv) => {
            println!("bound to {:?}", serv.local_addrs().unwrap());
            //			serv.set_timeout(5).unwrap();
            match serv.accept() {
                Err(e) => println!("{:?}", e.kind()),
                Ok((peer, _)) => {
                    println!(
                        "connection from {:?} on {:?}",
                        peer.peer_addrs().unwrap(),
                        peer.local_addrs().unwrap()
                    );
                    // Send message on stream 6
                    peer.sendmsg("foobar\n".as_bytes(), 6).unwrap();
                    let mut reply = [0u8; 1024];
                    let (len, stream) = peer.recvmsg(&mut reply).unwrap();
                    println!("Received {} bytes on stream {}", len, stream);
                }
            };
        }
        Err(e) => panic!("{:?}", e.kind()),
    }
}

examples/stream.rs (line 32)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn sendmsg_ppid(&self, msg: &[u8], ppid: u32, stream: u16) -> Result<usize>

Send bytes on the specified SCTP stream. On success, returns the quantity of bytes read

pub fn recvmsg(&self, msg: &mut [u8]) -> Result<(usize, u16)>

Read bytes. On success, return a tuple with the quantity of bytes received and the stream they were recived on

Examples found in repository

examples/listener.rs (line 21)

fn main() {
    match SctpListener::bind("0.0.0.0:3868") {
        //	match SctpListener::bindx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Ok(serv) => {
            println!("bound to {:?}", serv.local_addrs().unwrap());
            //			serv.set_timeout(5).unwrap();
            match serv.accept() {
                Err(e) => println!("{:?}", e.kind()),
                Ok((peer, _)) => {
                    println!(
                        "connection from {:?} on {:?}",
                        peer.peer_addrs().unwrap(),
                        peer.local_addrs().unwrap()
                    );
                    // Send message on stream 6
                    peer.sendmsg("foobar\n".as_bytes(), 6).unwrap();
                    let mut reply = [0u8; 1024];
                    let (len, stream) = peer.recvmsg(&mut reply).unwrap();
                    println!("Received {} bytes on stream {}", len, stream);
                }
            };
        }
        Err(e) => panic!("{:?}", e.kind()),
    }
}

examples/stream.rs (line 38)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn local_addrs(&self) -> Result<Vec<SocketAddr>>

Return the list of local socket addresses for this stream

Examples found in repository

examples/listener.rs (line 16)

fn main() {
    match SctpListener::bind("0.0.0.0:3868") {
        //	match SctpListener::bindx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Ok(serv) => {
            println!("bound to {:?}", serv.local_addrs().unwrap());
            //			serv.set_timeout(5).unwrap();
            match serv.accept() {
                Err(e) => println!("{:?}", e.kind()),
                Ok((peer, _)) => {
                    println!(
                        "connection from {:?} on {:?}",
                        peer.peer_addrs().unwrap(),
                        peer.local_addrs().unwrap()
                    );
                    // Send message on stream 6
                    peer.sendmsg("foobar\n".as_bytes(), 6).unwrap();
                    let mut reply = [0u8; 1024];
                    let (len, stream) = peer.recvmsg(&mut reply).unwrap();
                    println!("Received {} bytes on stream {}", len, stream);
                }
            };
        }
        Err(e) => panic!("{:?}", e.kind()),
    }
}

pub fn peer_addrs(&self) -> Result<Vec<SocketAddr>>

Return the list of socket addresses for the peer this stream is connected to

Examples found in repository

examples/listener.rs (line 15)

fn main() {
    match SctpListener::bind("0.0.0.0:3868") {
        //	match SctpListener::bindx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Ok(serv) => {
            println!("bound to {:?}", serv.local_addrs().unwrap());
            //			serv.set_timeout(5).unwrap();
            match serv.accept() {
                Err(e) => println!("{:?}", e.kind()),
                Ok((peer, _)) => {
                    println!(
                        "connection from {:?} on {:?}",
                        peer.peer_addrs().unwrap(),
                        peer.local_addrs().unwrap()
                    );
                    // Send message on stream 6
                    peer.sendmsg("foobar\n".as_bytes(), 6).unwrap();
                    let mut reply = [0u8; 1024];
                    let (len, stream) = peer.recvmsg(&mut reply).unwrap();
                    println!("Received {} bytes on stream {}", len, stream);
                }
            };
        }
        Err(e) => panic!("{:?}", e.kind()),
    }
}

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shuts down the read, write, or both halves of this connection

pub fn set_nodelay(&self, nodelay: bool) -> Result<()>

Set or unset SCTP_NODELAY option

Examples found in repository

examples/stream.rs (line 14)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn has_nodelay(&self) -> Result<bool>

Verify if SCTP_NODELAY option is activated for this socket

Examples found in repository

examples/stream.rs (line 13)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn set_buffer_size(&self, dir: SoDirection, size: usize) -> Result<()>

Set the socket buffer size for the direction specified by dir. Linux systems will double the provided size

Examples found in repository

examples/stream.rs (line 19)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn get_buffer_size(&self, dir: SoDirection) -> Result<usize>

Get the socket buffer size for the direction specified by dir

Examples found in repository

examples/stream.rs (line 18)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn set_timeout(&self, dir: SoDirection, timeout: i32) -> Result<()>

Set timeout in seconds for operation dir (either receive or send)

Examples found in repository

examples/stream.rs (line 27)

fn main() {
    // Create a new one-to-one stream
    match SctpStream::connect("127.0.0.1:3868") {
        //	match SctpStream::connectx(&["10.0.2.15:3868", "127.0.0.1:3868"]) {
        Err(e) => println!("{:?}", e.kind()),
        Ok(mut peer) => {
            // Set SCTP no delay
            println!("{}", peer.has_nodelay().unwrap());
            peer.set_nodelay(true).unwrap();
            println!("{}", peer.has_nodelay().unwrap());

            // Set socket send buffer size
            let oldsize = peer.get_buffer_size(SoDirection::Send).unwrap();
            peer.set_buffer_size(SoDirection::Send, 4096).unwrap();
            println!(
                "Set send buffer size to {} (was : {})",
                peer.get_buffer_size(SoDirection::Send).unwrap(),
                oldsize
            );

            println!("Setting read timeout to 10 s");
            peer.set_timeout(SoDirection::Receive, 10).unwrap();

            // Write a message using the io::Write trait
            peer.write_all("foo bar\n".as_bytes()).unwrap();
            // Write a message on stream 6
            peer.sendmsg("foo bar again\n".as_bytes(), 6).unwrap();
            let mut data = [0u8; 1024];
            // Read data using the io::Read trait
            peer.read_exact(&mut data).unwrap();
            // Read data using SCTP advanced feature, and retrieve the stream id
            // on which data were received
            let (size, stream) = peer.recvmsg(&mut data).unwrap();
            println!("Received {} bytes on stream {}", size, stream);
        }
    }
}

pub fn try_clone(&self) -> Result<SctpStream>

Try to clone the SctpStream. On success, returns a new stream wrapping a new socket handler

Trait Implementations

impl AsRawFd for SctpStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for SctpStream

unsafe fn from_raw_fd(fd: RawFd) -> SctpStream

Constructs a new instance of Self from the given raw file descriptor.

impl Read for SctpStream

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for SctpStream

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.