Struct async_osc::OscSocket

pub struct OscSocket { /* fields omitted */ }

A UDP socket to send and receive OSC messages.

Implementations

impl OscSocket

pub fn new(socket: UdpSocket) -> Self

Creates a new OSC socket from a async_std::net::UdpSocket.

pub async fn bind<A: ToSocketAddrs>(addr: A) -> Result<Self, Error>

Creates an OSC socket from the given address.

Binding with a port number of 0 will request that the OS assigns a port to this socket. The port allocated can be queried via local_addr method.

pub async fn connect<A: ToSocketAddrs>(&self, addrs: A) -> Result<(), Error>

Connects the UDP socket to a remote address.

When connected, only messages from this address will be received and the send method will use the specified address for sending.

Examples

use async_osc::{prelude::*, OscSocket, OscMessage};

let socket = OscSocket::bind("127.0.0.1:0").await?;
socket.connect("127.0.0.1:8080").await?;

pub async fn send_to<A: ToSocketAddrs, P: IntoOscPacket>(
    &self,
    packet: P,
    addrs: A
) -> Result<(), Error>

Sends an OSC packet on the socket to the given address.

Examples

use async_osc::{prelude::*, OscSocket, OscMessage};

let socket = OscSocket::bind("127.0.0.1:0").await?;
let addr = "127.0.0.1:5010";
let message = OscMessage::new("/volume", (0.8,));
socket.send_to(message, &addr).await?;

pub async fn send<P: IntoOscPacket>(&self, packet: P) -> Result<(), Error>

Sends a packet on the socket to the remote address to which it is connected.

The connect method will connect this socket to a remote address. This method will fail if the socket is not connected.

Examples

use async_osc::{prelude::*, OscSocket, OscMessage};

let socket = OscSocket::bind("127.0.0.1:34254").await?;
socket.connect("127.0.0.1:8080").await?;
socket.send(("/volume", (1.0f32,))).await?;

pub fn sender(&self) -> OscSender

Create a standalone sender for this socket.

The sender can be moved to other threads or tasks.

pub fn socket(&self) -> &UdpSocket

Get a reference to the underling UdpSocket.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

Returns the local address that this socket is bound to.

This can be useful, for example, when binding to port 0 to figure out which port was actually bound.

Trait Implementations

impl Debug for OscSocket

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

Formats the value using the given formatter.

impl Stream for OscSocket

type Item = Result<(OscPacket, SocketAddr), Error>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.