JUCE: OSCSender Class Reference

JUCE

Public Member Functions | List of all members
OSCSender Class Reference
juce_osc » osc

An OSC message sender. More...

`#include <juce_OSCSender.h>`

## Public Member Functions
| OSCSender ()
| Constructs a new OSCSender. More...
| ~OSCSender ()
| Destructor. More...
bool | connect (const String &targetHostName, int targetPortNumber)
| Connects to a datagram socket and prepares the socket for sending OSC packets to the specified target. More...
bool | connectToSocket (DatagramSocket &socket, const String &targetHostName, int targetPortNumber)
| Uses an existing datagram socket for sending OSC packets to the specified target. More...
bool | disconnect ()
| Disconnects from the currently used UDP port. More...
bool | send (const OSCMessage &message)
| Sends an OSC message to the target. More...
bool | send (const OSCBundle &bundle)
| Send an OSC bundle to the target. More...
bool | sendToIPAddress (const String &targetIPAddress, int targetPortNumber, const OSCMessage &message)
| Sends an OSC message to a specific IP address and port. More...
bool | sendToIPAddress (const String &targetIPAddress, int targetPortNumber, const OSCBundle &bundle)
| Sends an OSC bundle to a specific IP address and port. More...
template<typename... Args>
bool | send (const OSCAddressPattern &address, Args &&... args)
| Creates a new OSC message with the specified address pattern and list of arguments, and sends it to the target. More...
template<typename... Args>
bool | sendToIPAddress (const String &targetIPAddress, int targetPortNumber, const OSCAddressPattern &address, Args &&... args)
| Creates a new OSC message with the specified address pattern and list of arguments, and sends it to the target. More...

## Detailed Description

An OSC message sender.

An OSCSender object can connect to a network port. It then can send OSC messages and bundles to a specified host over an UDP socket.

## Constructor & Destructor Documentation

## ◆ OSCSender()

OSCSender::OSCSender | ( |  | ) |

Constructs a new OSCSender.

## ◆ ~OSCSender()

OSCSender::~OSCSender | ( |  | ) |

Destructor.

## Member Function Documentation

## ◆ connect()

bool OSCSender::connect | ( | const String & | targetHostName,
|  | int | targetPortNumber
| ) |  |

Connects to a datagram socket and prepares the socket for sending OSC packets to the specified target.

Note: The operating system will choose which specific network adapter(s) to bind your socket to, and which local port to use for the sender.

Parameters

  targetHostName | The remote host to which messages will be send.
  targetPortNumber | The remote UDP port number on which the host will receive the messages.

Returns
  true if the connection was successful; false otherwise.

See also
  send, disconnect.

## ◆ connectToSocket()

bool OSCSender::connectToSocket | ( | DatagramSocket & | socket,
|  | const String & | targetHostName,
|  | int | targetPortNumber
| ) |  |

Uses an existing datagram socket for sending OSC packets to the specified target.

Parameters

  socket | An existing datagram socket. Make sure this doesn't get deleted while this class is still using it!
  targetHostName | The remote host to which messages will be send.
  targetPortNumber | The remote UDP port number on which the host will receive the messages.

Returns
  true if the connection was successful; false otherwise.

See also
  connect, send, disconnect.

## ◆ disconnect()

bool OSCSender::disconnect | ( |  | ) |

Disconnects from the currently used UDP port.

Returns
  true if the disconnection was successful; false otherwise.

See also
  connect.

## ◆ send() [1/2]

bool OSCSender::send | ( | const OSCMessage & | message | ) |

Sends an OSC message to the target.

Parameters

  message | The OSC message to send.

Returns
  true if the operation was successful.

Referenced by send().

## ◆ send() [2/2]

bool OSCSender::send | ( | const OSCBundle & | bundle | ) |

Send an OSC bundle to the target.

Parameters

  bundle | The OSC bundle to send.

Returns
  true if the operation was successful.

## ◆ sendToIPAddress() [1/2]

bool OSCSender::sendToIPAddress | ( | const String & | targetIPAddress,
|  | int | targetPortNumber,
|  | const OSCMessage & | message
| ) |  |

Sends an OSC message to a specific IP address and port.

This overrides the address and port that was originally set for this sender.

Parameters

  targetIPAddress | The IP address to send to
  targetPortNumber | The target port number
  message | The OSC message to send.

Returns
  true if the operation was successful.

Referenced by sendToIPAddress().

## ◆ sendToIPAddress() [2/2]

bool OSCSender::sendToIPAddress | ( | const String & | targetIPAddress,
|  | int | targetPortNumber,
|  | const OSCBundle & | bundle
| ) |  |

Sends an OSC bundle to a specific IP address and port.

This overrides the address and port that was originally set for this sender.

Parameters

  targetIPAddress | The IP address to send to
  targetPortNumber | The target port number
  bundle | The OSC bundle to send.

Returns
  true if the operation was successful.

The documentation for this class was generated from the following file:

- juce_OSCSender.h