PureBasic

Set a Multipart Part Body from a Stream

Demonstrates Rest.SetMultipartBodyStream, which uses a Stream as the body source for the selected multipart part.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. Streaming a part body is appropriate for large parts because the data is read incrementally from the source rather than being buffered entirely in memory. The part is otherwise assembled the same way — select the part, set its headers, then set its body.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

    success.i = 0

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

    bTls.i = 1
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"example.com",443,bTls,bAutoReconnect)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ;  The file paths are relative to the application's current working directory.  Absolute paths
    ;  may also be used.  Supply the paths appropriate to your own environment.

    ;  Select the multipart part to build, and set its header fields.
    CkRest::setCkPartSelector(rest, "1")
    CkRest::ckAddHeader(rest,"Content-Disposition","form-data; name=" + Chr(34) + "field1" + Chr(34))
    CkRest::ckAddHeader(rest,"Content-Type","application/octet-stream")

    ;  Use a Stream as the body source for the selected part.  The stream's source is a local file,
    ;  which is appropriate for large parts.
    partStream.i = CkStream::ckCreate()
    If partStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStream::setCkSourceFile(partStream, "qa_data/attachment.bin")
    success = CkRest::ckSetMultipartBodyStream(rest,partStream)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStream::ckDispose(partStream)
        ProcedureReturn
    EndIf

    responseText.s = CkRest::ckFullRequestMultipart(rest,"POST","/api/upload")
    If CkRest::ckLastMethodSuccess(rest) = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStream::ckDispose(partStream)
        ProcedureReturn
    EndIf

    Debug responseText


    CkRest::ckDispose(rest)
    CkStream::ckDispose(partStream)


    ProcedureReturn
EndProcedure