Inheritance diagram for Urho3D::DataChannelConnection:

Public Member Functions
	DataChannelConnection (Context *context)

bool	Connect (const URL &url) override
	Address may be a full URL and port may be set to 0. Otherwise, port is appended to address.

void	Disconnect () override

bool	SendData (ConstByteSpan data, PacketTypeFlags type=PacketType::ReliableOrdered) override
	Sends data as-is via underlying transport. Data may be copied and sent asynchronously.

unsigned	GetMaxMessageSize () const override
	Return maximum size of raw network message.

void	SetIceServers (const StringVector &servers)

void	SetPortRange (unsigned begin, unsigned end)

void	SetIceUdpMux (bool enable)

void	SetIceTransportPolicy (rtc::TransportPolicy policy)

void	SetBindAddress (ea::string_view address)
	Bind to a specific local address (multi-homed servers with multiple NICs).

void	SetMtu (unsigned mtu)

std::shared_ptr< rtc::PeerConnection >	GetPeer () const

void	InitializeWithWebSocket (std::shared_ptr< rtc::WebSocket > ws, DataChannelServer *server=nullptr)

Public Member Functions inherited from Urho3D::NetworkConnection
	NetworkConnection (Context *context)

virtual bool	SendMessage (NetworkMessageId messageId, ConstByteSpan data, PacketTypeFlags type=PacketType::ReliableOrdered, ea::string_view debugInfo={})
	Sends network message. Data may be copied and sent asynchronously.

unsigned	GetMaxPayloadSize () const
	Return maximum size of network message payload.

const ea::string &	GetAddress () const
	Result may be empty, when connection is not NetworkConnectionState::Connected.

unsigned short	GetPort () const

NetworkConnectionState	GetState () const
	Return current state of the connection.

bool	IsConnected () const
	Return whether the connection is currently connected.

bool	IsDisconnected () const
	Return whether the connection is currently disconnected.

bool	GetProcessDataOnMainThread () const
	Return whether callbacks are invoked on the main thread.

void	SetProcessDataOnMainThread (bool enable)
	Set whether callbacks are invoked on the main thread.

NetworkServer *	GetServer () const
	Return server that owns this connection, if any.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.

template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.

template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.

void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.

void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.

void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.

void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.

void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.

void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

void	SendEvent (StringHash eventType)
	Send event to all subscribers.

void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.

VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.

Object *	GetEventSender () const
	Return active event sender. Null outside event handling.

EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.

bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.

bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.

bool	HasEventHandlers () const
	Return whether has subscribed to any event.

template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.

const ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

void	SetBlockEvents (bool block)
	Block object from sending and receiving events.

bool	GetBlockEvents () const
	Return sending and receiving events blocking status.

Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.

virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef () const

int	ReleaseRef () const

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	InitializeFromSocket (DataChannelServer *server, std::shared_ptr< rtc::WebSocket > websocket)

void	OnDataChannelConnected (int index)

void	OnDataChannelDisconnected (int index, bool notifyCallbacks=true)

Protected Member Functions inherited from Urho3D::NetworkConnection
void	NotifyDisconnecting ()
	Notify Network subsystem that teardown has started.

void	SetServer (NetworkServer *server)
	Set server that owns this connection.

virtual void	HandleConnected ()

virtual void	HandleDisconnected ()

virtual bool	HandleDataReceived (ConstByteSpan message)

virtual bool	HandleMessageReceived (NetworkMessageId messageId, ConstByteSpan message)

void	DispatchConnected ()
	Dispatch connection callback from transport implementation.

void	DispatchDisconnected ()
	Dispatch disconnection callback from transport implementation.

void	DispatchDataReceived (ConstByteSpan message)
	Dispatch data callback from transport implementation.

void	DispatchMessageReceived (NetworkMessageId messageId, ConstByteSpan message)
	Dispatch message callback from transport implementation.

Protected Attributes
std::shared_ptr< rtc::WebSocket >	websocket_

std::shared_ptr< rtc::PeerConnection >	peer_

std::shared_ptr< rtc::DataChannel >	dataChannels_ [4]

VectorBuffer	buffer_

bool	websocketWasOpened_ {}

StringVector	iceServers_

unsigned	portRangeBegin_ = 1024

unsigned	portRangeEnd_ = 65535

bool	enableIceUdpMux_ {}

rtc::TransportPolicy	iceTransportPolicy_ {}

ea::string	bindAddress_

unsigned	mtu_ {}

Protected Attributes inherited from Urho3D::NetworkConnection
NetworkConnectionState	state_ = NetworkConnectionState::Disconnected

ea::string	address_ = ""

unsigned short	port_ = 0

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
	URHO3D_OBJECT (DataChannelConnection, NetworkConnection)

Friends
class	DataChannelServer

Additional Inherited Members
Public Attributes inherited from Urho3D::NetworkConnection
Signal< void(), NetworkConnection >	OnConnected

Signal< void(), NetworkConnection >	OnDisconnected

Signal< void(ConstByteSpan data, bool &isHandled), NetworkConnection >	OnDataReceived

Signal< void(NetworkMessageId messageId, ConstByteSpan messagePayload, bool &isHandled), NetworkConnection >	OnMessageReceived

Signal< void(ConstByteSpan data, PacketTypeFlags, bool &isHandled), NetworkConnection >	OnSendData

Signal< void(NetworkMessageId messageId, ConstByteSpan messagePayload, PacketTypeFlags, ea::string_view debugInfo, bool &isHandled), NetworkConnection >	OnSendMessage

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Member Function Documentation

◆ Connect()

bool Urho3D::DataChannelConnection::Connect ( const URL & url )

overridevirtual

Address may be a full URL and port may be set to 0. Otherwise, port is appended to address.

Implements Urho3D::NetworkConnection.

◆ Disconnect()

void Urho3D::DataChannelConnection::Disconnect ( )

overridevirtual

Initializes a disconnection. Connection is no longer usable when this method returns, even though it may still remain connected for a short while.

Reimplemented from Urho3D::NetworkConnection.

◆ GetMaxMessageSize()

unsigned Urho3D::DataChannelConnection::GetMaxMessageSize ( ) const

overridevirtual

Return maximum size of raw network message.

Reimplemented from Urho3D::NetworkConnection.

◆ GetPeer()

std::shared_ptr< rtc::PeerConnection > Urho3D::DataChannelConnection::GetPeer ( ) const

inline

Access the underlying PeerConnection for advanced usage (ICE state, candidates, etc.). Requires knowledge of the rtc:: library. See WebRTC documentation for PeerConnection API.

◆ InitializeWithWebSocket()

void Urho3D::DataChannelConnection::InitializeWithWebSocket	(	std::shared_ptr< rtc::WebSocket >	ws,
		DataChannelServer *	server = `nullptr`
	)

Initialize with a pre-connected WebSocket (for relay/custom signaling). Allows using external signaling servers instead of direct WebSocket connections.

◆ SendData()

bool Urho3D::DataChannelConnection::SendData	(	ConstByteSpan	data,
		PacketTypeFlags	type = `PacketType::ReliableOrdered`
	)

overridevirtual

Sends data as-is via underlying transport. Data may be copied and sent asynchronously.

Reimplemented from Urho3D::NetworkConnection.

◆ SetIceServers()

void Urho3D::DataChannelConnection::SetIceServers ( const StringVector & servers )

inline

Configure ICE servers (STUN/TURN) for NAT traversal. Format: "stun:server:port" or "turn:user:pass@server:port"

◆ SetIceTransportPolicy()

void Urho3D::DataChannelConnection::SetIceTransportPolicy ( rtc::TransportPolicy policy )

inline

Force TURN-relay-only mode for strict firewalls where direct connections are impossible. When enabled, all media traffic goes through the TURN server.

◆ SetIceUdpMux()

void Urho3D::DataChannelConnection::SetIceUdpMux ( bool enable )

inline

Multiplex all peer connections onto a single UDP port (libjuice only). The clean solution for dedicated servers — only one port to forward.

◆ SetMtu()

void Urho3D::DataChannelConnection::SetMtu ( unsigned mtu )

inline

Override network MTU for WebRTC data channels (0 = use default). Useful for VPNs or tunnels with reduced path MTU to avoid UDP fragmentation.

◆ SetPortRange()

void Urho3D::DataChannelConnection::SetPortRange	(	unsigned	begin,
		unsigned	end
	)

Restrict WebRTC to a specific UDP port range (default: 1024-65535). Useful for port-forwarded direct connections where predictable ports are needed.

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

Urho3D/Network/DataChannel/DataChannelConnection.h
Urho3D/Network/DataChannel/DataChannelConnection.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Member Function Documentation

◆ Connect()

◆ Disconnect()

◆ GetMaxMessageSize()

◆ GetPeer()

◆ InitializeWithWebSocket()

◆ SendData()

◆ SetIceServers()

◆ SetIceTransportPolicy()

◆ SetIceUdpMux()

◆ SetMtu()

◆ SetPortRange()