TsgcUDPServer › Properties

TsgcUDPServer Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Connection

NameDescription
ActiveStarts or stops the UDP listener; read to query whether the server is currently bound and accepting datagrams.
HostLocal IP address the server listens on when Bindings is empty; leave blank to accept on every interface.
PortLocal UDP port the server listens on when Bindings is empty.
BindingsCollection of local IP/port endpoints that the server listens on for incoming UDP datagrams.
IPVersionSelects the IP stack (IPv4 or IPv6) used by the UDP listener when a binding is created from Host and Port.

Reliability

NameDescription
WatchDogAutomatic listener-recovery monitor that restarts the server after unexpected shutdowns or missed heartbeats.

Security

NameDescription
DTLSEnables Datagram TLS (DTLS) to encrypt the UDP traffic received and sent by this server.
DTLSOptionsCertificate, verification and OpenSSL settings applied when DTLS is enabled on the server.

Diagnostics

NameDescription
LogFileWrites every datagram received and sent by the server to a plain-text log file for diagnostics.
NotifyEventsControls how received-datagram, exception and lifecycle events are dispatched to the main thread.
VersionRead-only string with the sgcWebSockets library version that built this component.

All Properties (alphabetical)

NameDescription
ActiveStarts or stops the UDP listener; read to query whether the server is currently bound and accepting datagrams.
BindingsCollection of local IP/port endpoints that the server listens on for incoming UDP datagrams.
DTLSEnables Datagram TLS (DTLS) to encrypt the UDP traffic received and sent by this server.
DTLSOptionsCertificate, verification and OpenSSL settings applied when DTLS is enabled on the server.
HostLocal IP address the server listens on when Bindings is empty; leave blank to accept on every interface.
IPVersionSelects the IP stack (IPv4 or IPv6) used by the UDP listener when a binding is created from Host and Port.
LogFileWrites every datagram received and sent by the server to a plain-text log file for diagnostics.
NotifyEventsControls how received-datagram, exception and lifecycle events are dispatched to the main thread.
PortLocal UDP port the server listens on when Bindings is empty.
VersionRead-only string with the sgcWebSockets library version that built this component.
WatchDogAutomatic listener-recovery monitor that restarts the server after unexpected shutdowns or missed heartbeats.