HTTP & WebSocket

[dworkin]

A quick overview of how to use HTTP objects in the Cloud library.

A HTTP object is a clone of ~HTTP/api/obj/server1 (server) or ~HTTP/api/obj/client1 (client).

Include files: ~HTTP/HttpRequest.h, ~HTTP/HttpResponse.h, ~HTTP/HttpField.h

Once cloned, the object can be used as a HTTP connection object. In the following, => denotes a call to the HTTP object, <= denotes a callback.

create(object server)

• <= receiveRequest(int code, HttpRequest request)
• => doneRequest()
• => sendResponse(HttpResponse response)

create(object client, string host, int port)

• <= connected()
• <= connectFailed(int err)
• => sendRequest(HttpRequest request)
• <= receiveResponse(HttpResponse response)

Receiving data:

• => expectEntity(int length)
• <= receiveEntity(StringBuffer entity)

Receiving chunks:

• => expectChunk(varargs string compression)
• <= receiveChunkLine(int length, string *params)
• <= receiveChunk(StringBuffer chunk, HttpFields trailers)

Status callbacks:

• <= receiveError(string err)
• <= disconnected()

Receiving WebSocket frames/chunks:

• => expectWsFrame()
• <= receiveWsFrame(int opcode, int flags, int len)
• <= receiveWsChunk(StringBuffer chunk)

Sending chunks, WebSocket Chunks

• => sendChunk(StringBuffer chunk, varargs string *params)
• => endChunk(varargs string *params, HttpFields trailers)
• => sendWsChunk(int opcode, int flags, varargs int mask, StringBuffer chunk)
• <= doneChunk()

Terminating the connection:

• => terminate()

[dworkin]

I changed the second status callback from disconnect() to disconnected(), and changed connection termination from disconnect() to terminate().