PureBasic

S3 Streaming Upload with Expect: 100-continue

See more Amazon S3 (new) Examples

Demonstrates how to do an S3 streaming upload that includes an "Expect: 100-continue" request header. The purpose of sending an "Expect: 100-continue" header is to cleanly handle the case when the request fails, for whatever reason. (Failure reasons can be anything, such as a permissions problem, invalid authentication, etc.)

If no "Expect: 100-continue" header is included, and the AWS server rejects the request immediately after receiving the header, then this is what happens: The server closes the connection immediately after processing the request header. This results in a half-closed connection. Meanwhile, the client continues with sending the file data in the body of the HTTP request. Eventually, because nothing is consuming the data on the server-side, the outgoing socket buffer on the client (i.e. local machine) fills up, and an error such as "WSAECONNABORTED An established connection was aborted by the software in your host machine." is returned.

When the "Expect: 100-continue" is inclued, the server sends a response immediately after receiving the request header. A 100 response status code indicates that all is OK and the client should continue with sending the request body (i.e. file data), after which the server will respond with a final response.

PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkStream.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkCrypt2.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; This first part is optional.  AWS authentication requires
    ; the SHA-256 hash of the request body (i.e. the contents of the file
    ; to be uploaded).  We can choose to pre-calculate the SHA-256 in a streaming fashion
    ; and then provide it to the authenticator object.  This way, if the file is
    ; extremely large, it never needs to completely reside in memory.
    crypt.i = CkCrypt2::ckCreate()
    If crypt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkCrypt2::setCkEncodingMode(crypt, "hex")
    CkCrypt2::setCkHashAlgorithm(crypt, "sha-256")
    fileToUploadPath.s = "qa_data/xml/hamlet.xml"
    hashStr.s = CkCrypt2::ckHashFileENC(crypt,fileToUploadPath)

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

    ; Connect to the Amazon AWS REST server.
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"s3.amazonaws.com",port,bTls,bAutoReconnect)

    ; ----------------------------------------------------------------------------
    ; Important: For buckets created in regions outside us-east-1,
    ; there are three important changes that need to be made.
    ; See Working with S3 Buckets in Non-us-east-1 Regions for the details.
    ; ----------------------------------------------------------------------------

    ; Provide AWS credentials for the REST call.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    CkAuthAws::setCkServiceName(authAws, "s3")
    ; Provide the pre-computed SHA-256 here:
    CkAuthAws::setCkPrecomputedSha256(authAws, hashStr)

    success = CkRest::ckSetAuthAws(rest,authAws)

    ; Add an Expect: 100-continue request header
    CkRest::ckAddHeader(rest,"Expect","100-continue")

    ; Set the bucket name via the HOST header.
    ; In this case, the bucket name is "chilkat100".
    CkRest::setCkHost(rest, "chilkat100.s3.amazonaws.com")

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

    CkStream::setCkSourceFile(fileStream, fileToUploadPath)

    ; Upload to the S3 Storage service.
    ; If the application provided the SHA-256 hash of the file contents (as shown above)
    ; then file is streamed and never has to completely reside in memory.
    ; If the application did NOT provide the SHA-256, then Chilkat will (internally) 
    ; load the entire file into memory, calculate the SHA-256, and then upload.
    responseStr.s = CkRest::ckFullRequestStream(rest,"PUT","/hamlet.xml",fileStream)
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkCrypt2::ckDispose(crypt)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    ; When successful, the S3 Storage service will respond with a 200 response code,
    ; with an XML body.  
    If CkRest::ckResponseStatusCode(rest) = 200
        Debug responseStr
        Debug "File uploaded."
    Else
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body: " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
    EndIf



    CkCrypt2::ckDispose(crypt)
    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkStream::ckDispose(fileStream)


    ProcedureReturn
EndProcedure