OCP.1 TCP server that accepts a single incoming connection at a time. More...

#include <NanoOcp1.h>

Inheritance diagram for NanoOcp1::NanoOcp1Server:

Collaboration diagram for NanoOcp1::NanoOcp1Server:

Public Member Functions
	NanoOcp1Server (const bool callbacksOnMessageThread, const juce::Thread::Priority threadPriority=juce::Thread::Priority::normal)
	Constructs a server without an initial bind address/port.

	NanoOcp1Server (const juce::String &address, const int port, const bool callbacksOnMessageThread, const juce::Thread::Priority threadPriority=juce::Thread::Priority::normal)
	Constructs a server with bind address and port pre-configured.

	~NanoOcp1Server () override

bool	start () override
	Binds the socket and starts the accept loop thread.

bool	stop () override
	Stops the accept loop and closes any active connection.

bool	sendData (const ByteVector &data) override
	Sends serialized OCP.1 bytes to the currently connected peer. If no peer is connected, returns false.

Public Member Functions inherited from NanoOcp1::NanoOcp1Base
	NanoOcp1Base (const juce::String &address, const int port)

virtual	~NanoOcp1Base ()

void	setAddress (const juce::String &address)
	Sets the IP address or hostname of the remote OCA device.

const juce::String &	getAddress ()
	Returns the current target address.

void	setPort (const int port)
	Sets the TCP port number of the remote OCA device. DS100 default: 50014.

const int	getPort ()
	Returns the current target port number.

Public Member Functions inherited from NanoOcp1::Ocp1ConnectionServer
	Ocp1ConnectionServer (const juce::Thread::Priority threadPriority=juce::Thread::Priority::normal)
	Constructs the server.

	~Ocp1ConnectionServer () override

bool	beginWaitingForSocket (int portNumber, const juce::String &bindAddress=juce::String())
	Binds a TCP socket to the given port and starts the accept-loop thread.

void	stop ()
	Stops the accept-loop thread and closes the listening socket.

int	getBoundPort () const noexcept
	Returns the port number the server is bound to, or -1 if not listening.

Protected Member Functions
Ocp1Connection *	createConnectionObject () override
	Factory method called by the accept loop — creates the `NanoOcp1Client` peer object for the newly accepted TCP connection.

Protected Member Functions inherited from NanoOcp1::NanoOcp1Base
bool	processReceivedData (const ByteVector &data)
	Called by derived classes when bytes arrive from the socket. Invokes `onDataReceived` if set; the frame has already been delimited by `Ocp1Connection::readNextMessage()`.

Additional Inherited Members
Public Attributes inherited from NanoOcp1::NanoOcp1Base
std::function< bool(const ByteVector &)>	onDataReceived
	Fired when a complete OCP.1 frame is received.

std::function< void()>	onConnectionEstablished
	Fired once after a successful TCP connection is established.

std::function< void()>	onConnectionLost
	Fired when the TCP connection is dropped or a connect attempt fails.

Detailed Description

OCP.1 TCP server that accepts a single incoming connection at a time.

Useful when the local application acts as an OCA device (or simulator) and a remote controller connects to it. For the more common case of controlling a hardware device, use NanoOcp1Client instead.

Internally wraps Ocp1ConnectionServer (accept loop) and creates a NanoOcp1Client peer object when a connection arrives. The same three callbacks (onDataReceived, onConnectionEstablished, onConnectionLost) are available and behave identically to NanoOcp1Client.

Only one simultaneous connection is supported. A new incoming connection while one is already active replaces the previous one.

Definition at line 320 of file NanoOcp1.h.

Constructor & Destructor Documentation

◆ NanoOcp1Server() [1/2]

NanoOcp1::NanoOcp1Server::NanoOcp1Server	(	const bool	callbacksOnMessageThread,
		const juce::Thread::Priority	threadPriority = `juce::Thread::Priority::normal`
	)

Constructs a server without an initial bind address/port.

Parameters

callbacksOnMessageThread	See `NanoOcp1Client` constructor.
threadPriority	OS thread priority for the accept thread.

Definition at line 149 of file NanoOcp1.cpp.

◆ NanoOcp1Server() [2/2]

NanoOcp1::NanoOcp1Server::NanoOcp1Server	(	const juce::String &	address,
		const int	port,
		const bool	callbacksOnMessageThread,
		const juce::Thread::Priority	threadPriority = `juce::Thread::Priority::normal`
	)

Constructs a server with bind address and port pre-configured.

Parameters

address	Local address to bind to (empty = all interfaces).
port	TCP port to listen on.
callbacksOnMessageThread	See `NanoOcp1Client` constructor.
threadPriority	See other constructor.

Definition at line 154 of file NanoOcp1.cpp.