Class DeepstreamClient DeepstreamClient

The main entry point for a DeepstreamClient. Clients can be created directly using the initilizer or via DeepstreamFactory.getClient(), DeepstreamFactory.getClient(_:) or DeepstreamFactory.getClient(_:options:) to create a client and keep it as a singleton for future references.

Fields

record

Allows access to concepts related to deepstreamHub's realtime datastore, such as:

• get a reference to records via record.getRecord(_:)
• get a reference to list via record.getList(_:)
• retrieve a snapshot of the record data via record.snapshot(_:)

event

The entry point for events, such as:

• subscribing to events via event.subscribe(_:listener:)
• sending data on topics via event.emit(_:)
• listening for topic subscriptions via event.listen(_:listener:)

rpc

The entry point for RPCs, deepstreamHub's request-response mechanism:

• requesting via RpcHandler.make(_:data:)
• providing via RpcHandler.provide(_:listener:)

Initializers

init(_ url: String) throws

Creates a client instance using the default properties and initialises the connection to deepstreamHub. The connection will be kept in a quarantine state and won't be fully usable until DeepstreamClient.login() is called.

Show example...

guard let client = DeepstreamClient("< YOUR APP URL >") else {
    print("Unable to initialize client")
    return
}

init(_ url: String, properties: JsonElement) throws

Creates a client instance, merging the default options with the passed in configuration and initialises the connection to deepstreamHub. The connection will be kept in a quarantine state and won't be fully usable until DeepstreamClient.login() is called.

Show example...

let properties : [String : Int] = [
    "SUBSCRIPTION_TIMEOUT" : 500,
    "RECORD_READ_ACK_TIMEOUT" : 500,
    "RECORD_READ_TIMEOUT" : 500,
]
guard let client = DeepstreamClient("< YOUR APP URL >", properties: properties.toProperties) else {
    print("Unable to initialize client")
    return
}

Methods

class func setRuntimeErrorHandler(_ handler: DeepstreamRuntimeErrorHandler) -> Void

Adds a DeepstreamRuntimeErrorHandler that will catch all RuntimeErrors such as AckTimeouts and allow the user to gracefully handle them.

Show example...

final class RuntimeErrorHandler : NSObject, DeepstreamRuntimeErrorHandler {
    func onException(_ topic: Topic!, event: Event!, errorMessage: String!) {
        if (errorMessage != nil && topic != nil && event != nil) {
            print("Error: (errorMessage!) for topic: (topic!), event: (event!)")
        }
    }
}
client.setRuntimeErrorHandler(RuntimeErrorHandler())

class func login() -> LoginResult

Authenticates the client against the platform with an empty authentication object and returns a LoginResult. To learn more about how authentication works, please have a look at the Security Overview.

Show example...

guard let loginResult = client.login()
if (!loginResult.loggedIn()) {
    print("Failed to login (loginResult.getErrorEvent())")
} else {
    print("Login Success")
}

class func login(_ authParams: JsonElement) -> LoginResult

Authenticates the client against the platform with the given credentials and returns a LoginResult. To learn more about how authentication works, please have a look at the Security Overview.

Show example...

let authData = ["username" : "Publisher"]
guard let loginResult = client.login(authData.jsonElement)
if (!loginResult.loggedIn()) {
    print("Failed to login (loginResult.getErrorEvent())")
} else {
    print("Login Success")
}

class func close() -> Self

Ends the connection to the platform.

Show example...

final class ConnectionStateListenerImpl : NSObject, ConnectionStateListener {
    func connectionStateChanged(_ state: ConnectionState!) {
      // will be CLOSED once the connection is successfully closed
    }
}
client.addConnectionChangeListener(ConnectionStateListenerImpl())
client.close()

class func addConnectionChangeListener (_ listener: ConnectionStateListener) -> Self

Add a listener that can be notified via ConnectionStateListener.connectionStateChanged(_:) whenever the ConnectionState changes. A list of possible connection states is available here

Show example...

final class ConnectionStateListenerImpl : NSObject, ConnectionStateListener {
    func connectionStateChanged(_ state: ConnectionState!) {
      // handle change
    }
}
client.addConnectionChangeListener(ConnectionStateListenerImpl())

class func removeConnectionChangeListener(_ listener: ConnectionStateListener) -> Self

Removes a ConnectionStateListener added via DeepstreamClient.addConnectionChangeListener(_:)

Show example...

client.removeConnectionChangeListener(connectionStateChangedListener)

class func getUid() -> String

Returns a random id. The first block of characters is a timestamp, in order to allow databases to optimize for semi- sequentuel numberings.

Show example...

client.getUid()