MayaFlux 0.4.0
Digital-First Multimedia Processing Framework
Loading...
Searching...
No Matches
MayaFlux::Portal::Network Namespace Reference

Classes

class  NetworkSink
 Owned handle for sending data through a network stream. More...
 
struct  StreamConfig
 Full configuration for an outbound or bidirectional stream. More...
 
struct  StreamEndpoint
 Describes the remote (or local) side of a network stream. More...
 

Typedefs

using ByteView = std::span< const uint8_t >
 Convenience alias for a read-only byte view.
 
using StreamID = uint64_t
 Opaque handle returned by NetworkFoundry when a stream is opened.
 

Enumerations

enum class  FramingPolicy : uint8_t { NONE , LENGTH_PREFIX , CHUNKED }
 How outbound payloads are framed on the wire. More...
 
enum class  NetworkTransportHint : uint8_t { UDP , TCP , SHARED_MEMORY , AUTO }
 Portal-level transport hint, independent of Core::NetworkTransport. More...
 
enum class  StreamProfile : uint8_t { REALTIME_SMALL , REALTIME_BULK , ORDERED_BULK , ARBITRARY }
 Data characteristics that drive transport and framing selection. More...
 

Functions

std::optional< Core::InputValue::OSCMessageas_osc (const Core::NetworkMessage &msg)
 Parse a NetworkMessage payload as an OSC message.
 
bool initialize (Registry::Service::NetworkService *service)
 Initialize Portal::Network.
 
bool is_initialized ()
 Return true if Portal::Network has been initialized.
 
std::vector< uint8_t > serialize_osc (const std::string &address, const std::vector< Core::InputValue::OSCArg > &args)
 Serialize an OSC message to wire bytes for sending via NetworkService.
 
void shutdown ()
 Shutdown Portal::Network and release all resources.
 
void stop ()
 Stop active Portal::Network operations.
 

Variables

constexpr StreamID INVALID_STREAM = 0