Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

UDPSocketMBS.AddressFamily as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 18.4 Yes Yes Yes Yes No
Function: The address family of the socket.
Notes:
This is either RAWSocketMBS.AddressFamilyINet (2) for IPv4 or RAWSocketMBS.AddressFamilyINet6 (Mac 30, Windows 23 and Linux 10) for IPv6.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.AvailableBytes as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Returns number of bytes available for reading.
Notes:
Lasterror is set.
(Read only property)

Feedback, Comments & Corrections

UDPSocketMBS.BindAddress as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The IP used for bind operation.
Notes:
This is set by Bind on success.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.BindPort as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The port used for bind operation.
Notes:
This is set by Bind on success.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.Broadcast as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Whether broadcasts are allowed.
Notes:
Set to true before sending a broadcast message.
Internally this uses SOL_SOCKET/SO_BROADCAST option.
Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The internal socket handle.
Notes: (Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.Lasterror as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The last error code.
Notes:
Platform dependent.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.LocalIP as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 18.0 Yes Yes Yes Yes No
Function: Queries local IP.
Notes:
Can be 0.0.0.0 if unknown.
May only be set if connected or binded.
Lasterror is set.
(Read only property)

Feedback, Comments & Corrections

UDPSocketMBS.LocalPort as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 18.0 Yes Yes Yes Yes No
Function: Queries local port.
Notes:
Lasterror is set.
Can be -1 if unknown.
(Read only property)

Feedback, Comments & Corrections

UDPSocketMBS.MulticastInterface as String
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The interface to use for multicast.
Notes:
Internally this uses IPPROTO_IP/IP_MULTICAST_IF option.
Lasterror is set.

Assign empty string to use all interfaces.
May return 0.0.0.0 to indicate all interfaces.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.MulticastLoop as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Whether multicast packets are also sent to the sending socket.
Notes:
Internally this uses IPPROTO_IP/IP_MULTICAST_LOOP option.
Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.MulticastTimeToLive as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The multicast time to live value.
Notes:
Internally this uses IPPROTO_IP/IP_MULTICAST_TTL option.
Lasterror is set.
Range from 0 to 255.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.Protocol as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 18.3 Yes Yes Yes Yes No
Function: The socket protocol.
Notes:
Is ProtocolUDP (17) for UDP sockets.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.ReceiveBufferSize as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Queries the receiving buffer size.
Notes:
The buffer size may be increased for high-volume connections, or may be decreased to limit the possible backlog of incoming data. The system places an absolute limit on these values.
Internally this uses SOL_SOCKET/SO_RCVBUF option.
Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.ReuseAddress as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Allows reuse of same port.
Notes:
Internally this uses SOL_SOCKET/SO_REUSEADDR option.

see also
http://stackoverflow.com/questions/14388706/socket-options-so-reuseaddr-and-so-reuseport-how-do-they-differ-do-they-mean-t

Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.ReusePort as Boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.4 Yes Yes Yes Yes No
Function: Allow reuse of same port and IP.
Notes:
Internally this uses SOL_SOCKET/SO_REUSEPORT option.
On Windows, this is not supported, so this property sets ReuseAddress.
Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.SendBufferSize as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The sending buffer size.
Notes:
The buffer size may be increased for high-volume connections, or may be decreased to limit the possible backlog of incoming data. The system places an absolute limit on these values.
Internally this uses SOL_SOCKET/SO_SNDBUF option.
Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.SocketError as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The native socket error.
Notes:
Internally this uses SOL_SOCKET/SO_ERROR option.
Lasterror is set.
(Read only property)

Feedback, Comments & Corrections

UDPSocketMBS.SocketType as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 18.3 Yes Yes Yes Yes No
Function: The socket type.
Notes:
Is SocketTypeDatagram (2) for UDP sockets.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.TimeToLive as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The time to live value.
Notes:
Internally this uses IPPROTO_IP/IP_TTL option.
Lasterror is set.
Range from 0 to 255.
(Read and Write property)

Feedback, Comments & Corrections

UDPSocketMBS.Type as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: Socket type.
Notes:
Always 2 as this is a datagram socket.
Internally this uses SOL_SOCKET/SO_TYPE option.
Lasterror is set.
(Read only property)

Feedback, Comments & Corrections

UDPSocketMBS.TypeOfService as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Network MBS Network Plugin 14.3 Yes Yes Yes Yes No
Function: The type of service value.
Notes:
Works only on BSD Sockets.

Possible values:
IPTOS_MINCOST = 2
IPTOS_RELIABILITY = 4
IPTOS_THROUGHPUT = 8
IPTOS_LOWDELAY = 16

Internally this uses IPPROTO_IP/IP_TOS option.
(May not work on Windows.

Lasterror is set.
(Read and Write property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS Network Plugin.




Links
MBS Xojo Chart Plugins