HookupClient

The Hookup client provides a client for the hookup server, it doesn't lock you in to using a specific message format. The default implementation uses websockets to communicate with the server. You can opt-in or opt-out of every feature in the hookup client through configuration.

Usage of the simple hookup client:

  new HookupClient {
    val uri = new URI("ws://localhost:8080/thesocket")

    def receive = {
      case Disconnected(_) ⇒ println("The websocket to " + uri.toASCIIString + " disconnected.")
      case TextMessage(message) ⇒ {
        println("RECV: " + message)
        send("ECHO: " + message)
      }
    }

    connect() onSuccess {
      case Success ⇒
        println("The websocket to " + uri.toASCIIString + "is connected.")
      case _ ⇒
    }
  }

See also: io.backchat.hookup.HookupClientConfig

Linear Supertypes

Closeable, Reconnectable, Connectable, HookupClientLike, BroadcastChannelLike, AnyRef, Any

Known Subclasses

DefaultHookupClient, JavaHookupClient, PubSubClient

Abstract Value Members

abstract def receive: Receive

Handle inbound io.backchat.hookup.InboundMessage instances
Handle inbound io.backchat.hookup.InboundMessage instances
returns
a io.backchat.hookup.HookupClient.Receive as message handler

Definition Classes
HookupClientLike
abstract def settings: HookupClientConfig

The configuration of this client.
The configuration of this client.
returns
The io.backchat.hookup.HookupClientConfig as configuration object

Concrete Value Members

final def !(message: OutboundMessage): Future[OperationResult]

Send a message to the server.
Send a message to the server.
message
The io.backchat.hookup.OutboundMessage to send
returns
A scala.concurrent.Future with the io.backchat.hookup.OperationResult
final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def buffered: Boolean

A flag indicating whether this websocket client can fallback to buffering.
A flag indicating whether this websocket client can fallback to buffering.
returns
whether this websocket client can fallback to buffering or not.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def close(): Unit

Definition Classes
HookupClient → Closeable
final def connect(protocols: String*): Future[OperationResult]

Connect to the server.
Connect to the server.
returns
A scala.concurrent.Future with the io.backchat.hookup.OperationResult

Definition Classes
HookupClient → Connectable
final def disconnect(): Future[OperationResult]

Disconnect from the server.
Disconnect from the server.
returns
A scala.concurrent.Future with the io.backchat.hookup.OperationResult

Definition Classes
HookupClient → BroadcastChannelLike
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit lazy val executionContext: ExecutionContext

The execution context for futures within this client.
The execution context for futures within this client.
returns
The scala.concurrent.ExecutionContext

Attributes
protected
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def isConnected: Boolean

A flag indicating connection status.
A flag indicating connection status.
returns
a boolean indicating connection status

Definition Classes
HookupClient → Connectable
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reconnect(): Future[OperationResult]

Reconnect to the server.
Reconnect to the server.
returns
A scala.concurrent.Future with the io.backchat.hookup.OperationResult

Definition Classes
HookupClient → Reconnectable
final def send(message: String): Future[OperationResult]
final def send(message: OutboundMessage): Future[OperationResult]

Send a message to the server.
Send a message to the server.
message
The io.backchat.hookup.OutboundMessage to send
returns
A scala.concurrent.Future with the io.backchat.hookup.OperationResult

Definition Classes
HookupClient → BroadcastChannelLike
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait HookupClient extends HookupClientLike with Connectable with Reconnectable with Closeable

Abstract Value Members

abstract def receive: Receive

abstract def settings: HookupClientConfig

Concrete Value Members

final def !(message: OutboundMessage): Future[OperationResult]

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def buffered: Boolean

def clone(): AnyRef

final def close(): Unit

final def connect(protocols: String*): Future[OperationResult]

final def disconnect(): Future[OperationResult]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

implicit lazy val executionContext: ExecutionContext

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def isConnected: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reconnect(): Future[OperationResult]

final def send(message: String): Future[OperationResult]

final def send(message: OutboundMessage): Future[OperationResult]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Closeable

Inherited from Reconnectable

Inherited from Connectable

Inherited from HookupClientLike

Inherited from BroadcastChannelLike

Inherited from AnyRef

Inherited from Any

Ungrouped