python-osc/pythonosc/udp_client.py at master · nocarryr/python-osc · GitHub

History

71 lines (55 loc) · 2.34 KB

Raw

"""UDP Clients for sending OSC messages to an OSC server"""

from collections import Iterable

import socket

from .osc_message_builder import OscMessageBuilder

from pythonosc.osc_message import OscMessage

from pythonosc.osc_bundle import OscBundle

from typing import Union

class UDPClient(object):

"""OSC client to send :class:`OscMessage` or :class:`OscBundle` via UDP"""

def __init__(self, address: str, port: int, allow_broadcast: bool = False) -> None:

"""Initialize client

As this is UDP it will not actually make any attempt to connect to the

given server at ip:port until the send() method is called.

Args:

address: IP address of server

port: Port of server

allow_broadcast: Allow for broadcast transmissions

"""

for addr in socket.getaddrinfo(address, port, type=socket.SOCK_DGRAM):

af, socktype, protocol, canonname, sa = addr

try:

self._sock = socket.socket(af, socktype)

except OSError:

continue

break

self._sock.setblocking(0)

if allow_broadcast:

self._sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)

self._address = address

self._port = port

def send(self, content: Union[OscMessage, OscBundle]) -> None:

"""Sends an :class:`OscMessage` or :class:`OscBundle` via UDP

Args:

content: Message or bundle to be sent

"""

self._sock.sendto(content.dgram, (self._address, self._port))

class SimpleUDPClient(UDPClient):

"""Simple OSC client that automatically builds :class:`OscMessage` from arguments"""

def send_message(self, address: str, value: Union[int, float, bytes, str, bool, tuple, list]) -> None:

"""Build :class:`OscMessage` from arguments and send to server

Args:

address: OSC address the message shall go to

value: One or more arguments to be added to the message

"""

builder = OscMessageBuilder(address=address)

if value is None:

values = []

elif not isinstance(value, Iterable) or isinstance(value, (str, bytes)):

values = [value]

else:

values = value

for val in values:

builder.add_arg(val)

msg = builder.build()

self.send(msg)

python-osc/pythonosc/udp_client.py at master · nocarryr/python-osc · GitHub

Expand file tree

Breadcrumbs

udp_client.py

Latest commit

History

Breadcrumbs

udp_client.py

File metadata and controls