Xojo Plugin
Xojo Plugin
ReceiveSb Returns Only the Immediately Available Data
See more Socket/SSL/TLS Examples
Demonstrates that Socket.ReceiveSb returns only the data immediately available and not the entire response. The example connects to chilkatsoft.com over TLS and requests big_helloWorld.txt, a large text file of roughly 74,000 lines. A single ReceiveSb call returns just the first portion of the response, and the example reports how many characters were received compared with the total size given by the response Content-Length header.
Background. Because ReceiveSb returns whatever bytes are currently available, one call cannot indicate whether the full response has arrived. Knowing when a response is complete requires either a known expected length (such as a Content-Length header or an application-defined length prefix), receiving in a loop until that many bytes are collected, or receiving until the peer closes the connection. This example sends a minimal HTTP request only to exercise ReceiveSb against a public server; for actual HTTP work, use the Chilkat Http, Rest, or HttpCurl classes.
Chilkat Xojo Plugin Downloads
Dim success As Boolean
success = False
Dim socket As New Chilkat.Socket
// Connect to chilkatsoft.com over TLS.
Dim bTls As Boolean
bTls = True
Dim maxWaitMs As Int32
maxWaitMs = 5000
success = socket.Connect("chilkatsoft.com",443,bTls,maxWaitMs)
If (success = False) Then
System.DebugLog(socket.LastErrorText)
Return
End If
socket.StringCharset = "utf-8"
// Send an HTTP GET request for big_helloWorld.txt, a large text file of roughly 74,000 lines of
// "Hello World!". This uses a minimal HTTP request only to exercise ReceiveSb against a public
// server -- for real HTTP work, use the Chilkat Http, Rest, or HttpCurl classes instead.
Dim httpReq As String
httpReq = "GET /big_helloWorld.txt HTTP/1.1" + EndOfLine.Windows + "Host: chilkatsoft.com" + EndOfLine.Windows + "Connection: close" + EndOfLine.Windows + EndOfLine.Windows
success = socket.SendString(httpReq)
If (success = False) Then
System.DebugLog(socket.LastErrorText)
Return
End If
// Call ReceiveSb a single time. It returns only the bytes that are immediately available --
// typically just the first network packet -- and does NOT wait for the entire response to arrive.
Dim sb As New Chilkat.StringBuilder
success = socket.ReceiveSb(sb)
If (success = False) Then
System.DebugLog(socket.LastErrorText)
Return
End If
// The response begins with HTTP headers. The Content-Length header gives the total size, in bytes,
// of the response body.
Dim contentLength As String
contentLength = sb.GetBetween("Content-Length: ",EndOfLine.Windows)
If (sb.LastMethodSuccess = False) Then
System.DebugLog(sb.LastErrorText)
Return
End If
// Compare what this single ReceiveSb returned against the full size of the expected response. The
// received amount is only a small fraction of the total.
System.DebugLog("Characters received so far (headers + partial body): " + Str(sb.Length))
System.DebugLog("Expected response body size (Content-Length): " + contentLength + " bytes")
// A single ReceiveSb call returns whatever is currently available, so it cannot indicate whether the
// full response has arrived. This makes it difficult to know when a response is complete: the
// application must either know how many bytes to expect (for example from a Content-Length header or
// an application-defined length prefix) and keep receiving until that many bytes are collected, or
// keep receiving until the peer closes the connection.