class obix::ObixClient

sys::Obj
  obix::ObixClient

Source

ObixClient implements the client side of the oBIX HTTP REST protocol.

aboutUri

Uri? aboutUri

Source

About object relative URI - either set manually or via readLobby.

batchRead

ObixObj[] batchRead(Uri[] uris)

Source

Perform a batch read for all the given URIs. The batchUri must be either set manually or via readLobby.

batchUri

Uri? batchUri

Source

Batch operation relative URI - either set manually or via readLobby.

invoke

ObixObj invoke(Uri uri, ObixObj in)

Source

Invoke the operation identified by the specified href. If the result is* an <err> object, then throw an ObixErr with the object.

lobbyUri

const Uri lobbyUri

Source

Uri of the lobby object

main

static Void main(Str[] args)

Source

make

new make(Uri lobby, Str:Str authHeaders)

Source

Construct with given headers to use for authentication

makeBasicAuth

static new makeBasicAuth(Uri lobby, Str username, Str password)

Source

Construct to use Basic Authentication

read

ObixObj read(Uri uri)

Source

Read an obix document with the specified href. If the result is an <err> object, then throw an ObixErr with the object.

readAbout

ObixObj readAbout()

Source

Read about object. The aboutUri must be either set manually or via readLobby.

readLobby

ObixObj readLobby()

Source

Read the lobby object. This method will set the aboutUri and batchUri fields.

watchOpen

ObixClientWatch watchOpen()

Source

Create a new watch from via watchServiceUri and return the object which represents the watch. Raise err if watch service isn't available.

watchServiceUri

Uri? watchServiceUri

Source

Watch service relative URI - either set manually or via readLobby

write

ObixObj write(ObixObj obj)

Source

Write an obix document to the specified href and return the server's result. If the result is an <err> object, then throw an ObixErr with the object.