Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

Platforms to show: All Mac Windows Linux Cross-Platform

ClearOptionsMBS(extends s as SocketCore)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Clears all options.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

Feedback, Comments & Corrections

OptionKeepAliveMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 15.0 Yes Yes Yes Yes No
Function: Gets the keep alive.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Returns -1 on any error.

Enables the periodic transmission of messages on a connected socket. Should the connected party fail to respond to these messages, the connection is considered broken and processes using the socket are notified via a SIGPIPE signal when attempting to send data.

See also:

Feedback, Comments & Corrections

OptionKeepAliveMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 15.0 Yes Yes Yes Yes No
Function: Sets the keep alive.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.

Enables the periodic transmission of messages on a connected socket. Should the connected party fail to respond to these messages, the connection is considered broken and processes using the socket are notified via a SIGPIPE signal when attempting to send data.

See also:

Feedback, Comments & Corrections

OptionMaximumSegmentSizeMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Queries the maximum segment size.
Example:
dim s as new TCPSocket

s.Port = 0
s.listen

MsgBox str(s.OptionMaximumSegmentSizeMBS)
Notes:
Only for TCP sockets.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionMaximumSegmentSizeMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Adjusts the maximum segment size.
Notes: Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionMutliCastTTLMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Gets the multicast time to live value.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionMutliCastTTLMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Sets the multicast time to live value.
Example:
dim t as new UDPSocket

// create a socket
t.Port=80
t.Connect

// wait a second to connect
app.DoEvents 1000

// shows handle
MsgBox str(t.Handle)

// shows current value
MsgBox str(t.OptionMutliCastTTLMBS)
t.OptionMutliCastTTLMBS=10

// shows new value
MsgBox str(t.OptionMutliCastTTLMBS)
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionReceiveBufferSizeMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 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.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionReceiveBufferSizeMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Adjusts 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.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionSendBufferSizeMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Queries the sending buffer size.
Example:
dim s as new UDPSocket

s.Port = 0
s.Connect

MsgBox str(s.OptionSendBufferSizeMBS)
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.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionSendBufferSizeMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Adjusts 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.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionTOSMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Gets the type of service value.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionTOSMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Sets the type of service value.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Possible values:
IPTOS_MINCOST = 2
IPTOS_RELIABILITY = 4
IPTOS_THROUGHPUT = 8
IPTOS_LOWDELAY = 16

You may want to set it after connecting.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionTTLMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Gets the time to live value.
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionTTLMBS(extends s as SocketCore, assigns value as Integer)
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 8.0 Yes Yes Yes Yes No
Function: Sets the time to live value.
Example:
dim t as new TCPSocket

// create a socket
t.Port=80
t.Address="www.apple.com"
t.Connect

// wait a second to connect
app.DoEvents 1000

// shows handle
MsgBox str(t.Handle)

// shows current value
MsgBox str(t.OptionTTLMBS)
t.OptionTTLMBS=10

// shows new value
MsgBox str(t.OptionTTLMBS)
Notes:
Works only on BSD Sockets and if the socket handle value is valid.
Raises UnsupportedOperationException in case of failure.

See also:

Some examples using this method:

Feedback, Comments & Corrections

OptionTypeMBS(extends s as SocketCore) as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
global method Network MBS Network Plugin 13.0 Yes Yes Yes Yes No
Function: Queries the type of socket.
Example:
dim u as new UDPSocket

u.Port = 9000
u.Connect

// shows 2 for UDP
MsgBox str(u.OptionTypeMBS)
Notes:
Type is 1 for stream socket, 2 for datagram socket, 3 for raw socket, 4 for reliably-delivered message socket and 5 for a sequenced packet stream.
Raises UnsupportedOperationException in case of failure.

Some examples using this method:

Feedback, Comments & Corrections

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




Links
MBS Xojo Chart Plugins