TURN Component
Properties Methods Events Configuration Settings Errors
TBD.
Syntax
ipworksp2p.Turn
Remarks
TBD
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Active | Enables or disables sending and receiving of data. |
AutoRefresh | Whether the allocation should be refreshed automatically. |
Channels | A collection of currently open channels. |
Lifetime | The lifetime of the allocation. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The UDP port in the local host where the component binds. |
Password | The password to use for authentication. |
Permissions | A collection of active permissions. |
PublicIP | The public IP address returned by the server for the local host. |
PublicPort | The public port returned by the server for the local host. |
Realm | The realm to use for authentication. |
RelayedIP | The IP address allocated on the server for the component. |
RelayedPort | The port allocated on the server for the component. |
Software | The software string to report to the server when sending requests. |
Timeout | A timeout for the component. |
TTL | The number of seconds remaining until the allocation expires. |
TURNPort | The port to connect to on the TURN server. |
TURNServer | The TURN server to connect to. |
User | The user name to use for authentication. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Allocate | Allocates a relayed IP address and port on the server. |
Config | Sets or retrieves a configuration setting. |
CreateChannel | Creates a new channel. |
CreatePermission | Creates a new permission. |
DoEvents | Processes events from the internal message queue. |
RefreshAllocation | Refreshes the allocation. |
Reset | Reset the component. |
SendChannelData | Sends data to a peer using a given channel. |
SendData | Sends data to a peer using an indication. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
DataIn | (TBD rename to DataIn.evt) Fires when data is received from a peer. |
Error | Information about errors during data delivery. |
Expired | Fires when an allocation, permission, or channel has expired. |
Log | Fires once for each log message. |
OAuth | Fires when received Third-Party Authorization attributes. |
ReadyToSend | Fired when the component is ready to send data. |
UnknownAttr | Fires when an unknown attribute is found in an incoming message. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AllocateAddressFamily | Which address family to request an allocation for. |
DontFragment | Whether the DONT-FRAGMENT attribute should be included in applicable requests. |
DTLSSRTPCompatibility | Whether to restrict the channel number range for DTLS-SRTP collision avoidance. |
EvenPort | Whether an even port should be allocated. |
EvenPortReserveNext | Whether the server should also reserve the port immediately following the even port. |
LogLevel | Specifies the level of detail that is logged. |
ReservationToken | A token used to claim a reserved allocation. |
AuthType | Overrides the authentication type used by the component. |
LogLevel | Specifies the level of detail that is logged. |
Nonce | The nonce value being used for authentication currently. |
RemoteSoftware | The software string reported by the server. |
CaptureIPPacketInfo | Used to capture the packet information. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the component to be active on the same local port. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the component are daemon threads. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |