PureBasic

How to Avoid Large Strings in HTTP Responses

See more HTTP Examples

In some programming languages/environments, returning and passing large strings is problematic for both performance and other reasons (for example, with SQL Server limitations on sizes varchar variables).

One way of avoiding the need to return the actual string data, is to pass the data from one place to another via a Chilkat StringBuilder or BinData object. This example demonstrates a simple HTTP GET where the response body contains XML approximately 274K in size. The response body is loaded into the Chilkat.Xml without the XML content ever needing to leave the native code internal to Chilkat.

PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkXml.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example assumes the Chilkat HTTP API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpNoBody(http,"GET","https://www.chilkatsoft.com/hamlet.xml",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    sb.i = CkStringBuilder::ckCreate()
    If sb.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Copy the response body to sb.
    success = CkHttpResponse::ckGetBodySb(resp,sb)

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load the XML from the sb.
    bAutoTrim.i = 0
    success = CkXml::ckLoadSb(xml,sb,bAutoTrim)

    Debug "The response body was " + Str(CkStringBuilder::ckLength(sb)) + " characters in length."
    Debug "Success."

    ; The output is:
    ; 
    ; 	The response body was 279658 characters in length.
    ; 	Success.


    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)
    CkStringBuilder::ckDispose(sb)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure