Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

Socket.Read

Reads bytes from socket and returns them as text.

Component Version macOS Windows Linux Server iOS SDK
Socket 3.1 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "Socket.Read"; SocketID; length { ; Encoding } )   More

Parameters

Parameter Description Example Flags
SocketID The socket ID received by Socket.Connect function. $sock
length Maximum number of bytes to read. 10
Encoding The text encoding for result.
Default is native. This function can also handle UTF-16 as well as UTF-16LE and UTF-16BE for little/big endian byte order.
Possible encoding names: ANSI, ISO-8859-1, Latin1, Mac, Native, UTF-8, DOS, Hex, Base64 or Windows. More listed in the FAQ.
UTF8 Optional

Result

Returns text or error message.

Description

Reads bytes from socket and returns them as text.
The text returned may be shorter than length bytes.

The buffer size of the socket is managed by the OS and can be several megabytes big if needed.
To read the whole input buffer, use Socket.ReadAll. To look into buffer without removing text, please use Socket.Peek function instead.

Please leave some time between Socket.Write calls and a subsequent reading of the results with a read function, so the other side has time to process your request. A script pause of a second or two may help.

Examples

Read up to 8 bytes and decode them from Windows text encoding into FileMaker:

$value = MBS( "Socket.Read"; $sock; 8; "windows" )

Connect to a HTTP Server and wait for answer:

Set Variable [$r; Value:MBS("Trace")]
Set Variable [$sock; Value:MBS("Socket.Connect"; TCP Socket::DomainOrIP; 80)]
If [MBS("IsError")]
    Show Custom Dialog ["Error"; $sock]
    Exit Script []
End If
Set Variable [$request; Value:"GET "&TCP Socket::Path&" HTTP/1.0¶Host: "&TCP Socket::DomainOrIP&"¶¶"]
Set Variable [$request; Value:MBS("Text.ReplaceNewline"; $request; 2)]
Set Field [TCP Socket::RequestUsed; $request]
Set Variable [$r; Value:MBS("Socket.Write"; $sock; $request)]
Pause/Resume Script [Duration (seconds): 1]
Set Variable [$data; Value:MBS("Socket.Read"; $sock; 1000)]
Set Variable [$data; Value:MBS("Text.ReplaceNewline"; $data; 1)]
Set Field [TCP Socket::Result; $data]
Set Variable [$r; Value:MBS("Socket.Close"; $sock)]

Read data and put in a new record:

Set Variable [$r; Value:MBS("Socket.Read"; $$sock; 1500; "UTF-8")]
If [MBS("IsError")]
    Show Custom Dialog ["Error Reading"; $r]
Else If [Length($r) = 0]
    Show Custom Dialog ["Error Reading"; "No data available."]
Else
    New Record/Request
    Set Field [UDP Broadcast::Message Received; $r]
    Set Field [UDP Broadcast::Sender; MBS("Socket.LastMessageIP"; $$sock)]
    Commit Records/Requests [No dialog]
End If

See also

Release notes

Example Databases

Blog Entries

This function is free to use.

Created 18th August 2014, last changed 29th July 2022


Socket.PeekHex - Socket.ReadAll

💬 Ask a question or report a problem