org.atmosphere.wasync.serial

Class SerializedClient

java.lang.Object

org.atmosphere.wasync.serial.SerializedClient

All Implemented Interfaces:

Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

public class SerializedClient
extends Object
implements Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

SerializedClient is a Client that guarantees ordered message delivery, in-line with the Socket.fire(Object) invocation sequence.

A sequence of fire calls over a SerializedClient's socket (created through create() :

     socket.fire("message1").fire("message2");
 

guarantees that message1 arrives at the recipient-side before message2. By default, wAsync uses multiple underlying connections in delivering fire payloads. The SerializedClient guarantees that only one connection is used at any moment in time, while still providing an asynchronous fire interface to clients.

SerializedClient instances can be configured by means of a SerializedFireStage in deciding on the exact staging semantics and the (non-functional) quality properties of a supporting stage. The default implementation provided is DefaultSerializedFireStage.

Author:

Christian Bach

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SerializedClient.SerializedRequestBuilder

Constructor Summary

Constructors

Constructor and Description
SerializedClient()

Method Summary

Methods

Modifier and Type	Method and Description
Socket	create() Create a Socket
Socket	create(SerializedOptions options) Create a Socket configured using the Options
SerializedOptionsBuilder	newOptionsBuilder() Return an OptionsBuilder
SerializedClient.SerializedRequestBuilder	newRequestBuilder() Return a RequestBuilder
SerializedClient.SerializedRequestBuilder	newRequestBuilder(Class<SerializedClient.SerializedRequestBuilder> clazz) Create a new RequestBuilder based on the class' implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerializedClient

public SerializedClient()

Method Detail

create

public Socket create(SerializedOptions options)

Create a Socket configured using the Options

Specified by:

create in interface Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

Returns:

Socket

create

public Socket create()

Create a Socket

Specified by:

create in interface Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

Returns:

Socket

newOptionsBuilder

public SerializedOptionsBuilder newOptionsBuilder()

Return an OptionsBuilder

Specified by:

newOptionsBuilder in interface Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

Returns:

OptionsBuilder

newRequestBuilder

public SerializedClient.SerializedRequestBuilder newRequestBuilder()

Return a RequestBuilder

Specified by:

newRequestBuilder in interface Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

Returns:

a RequestBuilder

newRequestBuilder

public SerializedClient.SerializedRequestBuilder newRequestBuilder(Class<SerializedClient.SerializedRequestBuilder> clazz)

Create a new RequestBuilder based on the class' implementation.

Specified by:

newRequestBuilder in interface Client<SerializedOptions,SerializedOptionsBuilder,SerializedClient.SerializedRequestBuilder>

Parameters:

clazz - an implementation of RequestBuilder

Returns:

a RequestBuilder