microsoft.aspnet.signalr.client.hubs

Class HubProxy

java.lang.Object

microsoft.aspnet.signalr.client.hubs.HubProxy

public class HubProxy
extends Object

Proxy for hub operations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HubProxy(HubConnection connection, String hubName, Logger logger) Initializes the HubProxy

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonElement	getState(String key) Gets the state for a key
<E> E	getValue(String key, Class<E> clazz) Gets the value for a key
<E> SignalRFuture<E>	invoke(Class<E> resultClass, String method, Object... args) Invokes a hub method that returns a value
<E> SignalRFuture<E>	invoke(Class<E> resultClass, Type resultType, String method, Object... args) Overload of 'invoke' hub method that takes a type instead of class for GSON deserialisation
SignalRFuture<Void>	invoke(String method, Object... args) Invokes a hub method
protected void	log(String message, LogLevel level)
<E1> void	on(String eventName, SubscriptionHandler handler)
<E1> void	on(String eventName, SubscriptionHandler1<E1> handler, Class<E1> parameter1)
<E1,E2> void	on(String eventName, SubscriptionHandler2<E1,E2> handler, Class<E1> parameter1, Class<E2> parameter2)
<E1,E2,E3> void	on(String eventName, SubscriptionHandler3<E1,E2,E3> handler, Class<E1> parameter1, Class<E2> parameter2, Class<E3> parameter3)
<E1,E2,E3,E4> void	on(String eventName, SubscriptionHandler4<E1,E2,E3,E4> handler, Class<E1> parameter1, Class<E2> parameter2, Class<E3> parameter3, Class<E4> parameter4)
<E1,E2,E3,E4,E5> void	on(String eventName, SubscriptionHandler5<E1,E2,E3,E4,E5> handler, Class<E1> parameter1, Class<E2> parameter2, Class<E3> parameter3, Class<E4> parameter4, Class<E5> parameter5)
void	removeSubscription(String eventName) Removes all the subscriptions attached to an event
void	setState(String key, com.google.gson.JsonElement state) Sets the state for a key
void	subscribe(Object handler) Create subscriptions for all the object methods
Subscription	subscribe(String eventName) Creates a subscription to an event

Methods inherited from class java.lang.Object

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

Constructor Detail

HubProxy

protected HubProxy(HubConnection connection,
                   String hubName,
                   Logger logger)

Initializes the HubProxy

Parameters:

connection - HubConnection to use

hubName - Hub name

logger - Logger

Method Detail

setState

public void setState(String key,
                     com.google.gson.JsonElement state)

Sets the state for a key

Parameters:

key - Key to set

state - State to set

getState

public com.google.gson.JsonElement getState(String key)

Gets the state for a key

Parameters:

key - Key to get

Returns:

JsonElement

getValue

public <E> E getValue(String key,
                      Class<E> clazz)

Gets the value for a key

Type Parameters:

E - Class

Parameters:

key - Key to get

clazz - Class used to to deserialize the value

Returns:

Class Class

subscribe

public Subscription subscribe(String eventName)

Creates a subscription to an event

Parameters:

eventName - The name of the event

Returns:

The subscription object

subscribe

public void subscribe(Object handler)

Create subscriptions for all the object methods

Parameters:

handler - Handler for the hub messages

removeSubscription

public void removeSubscription(String eventName)

Removes all the subscriptions attached to an event

Parameters:

eventName - the event

invoke

public SignalRFuture<Void> invoke(String method,
                                  Object... args)

Invokes a hub method

Parameters:

method - Method name

args - Method arguments

Returns:

A Future for the operation

invoke

public <E> SignalRFuture<E> invoke(Class<E> resultClass,
                                   String method,
                                   Object... args)

Invokes a hub method that returns a value

Type Parameters:

E - Class

Parameters:

resultClass - Result class

method - Method name

args - Method arguments

Returns:

A Future for the operation, that will return the method result

invoke

public <E> SignalRFuture<E> invoke(Class<E> resultClass,
                                   Type resultType,
                                   String method,
                                   Object... args)

Overload of 'invoke' hub method that takes a type instead of class for GSON deserialisation

Type Parameters:

E - Class

Parameters:

resultClass - Result class

resultType - Result type

method - Method name

args - Method arguments

Returns:

A Future for the operation, that will return the method result

on

public <E1,E2,E3,E4,E5> void on(String eventName,
                                SubscriptionHandler5<E1,E2,E3,E4,E5> handler,
                                Class<E1> parameter1,
                                Class<E2> parameter2,
                                Class<E3> parameter3,
                                Class<E4> parameter4,
                                Class<E5> parameter5)

on

public <E1,E2,E3,E4> void on(String eventName,
                             SubscriptionHandler4<E1,E2,E3,E4> handler,
                             Class<E1> parameter1,
                             Class<E2> parameter2,
                             Class<E3> parameter3,
                             Class<E4> parameter4)

on

public <E1,E2,E3> void on(String eventName,
                          SubscriptionHandler3<E1,E2,E3> handler,
                          Class<E1> parameter1,
                          Class<E2> parameter2,
                          Class<E3> parameter3)

on

public <E1,E2> void on(String eventName,
                       SubscriptionHandler2<E1,E2> handler,
                       Class<E1> parameter1,
                       Class<E2> parameter2)

on

public <E1> void on(String eventName,
                    SubscriptionHandler1<E1> handler,
                    Class<E1> parameter1)

on

public <E1> void on(String eventName,
                    SubscriptionHandler handler)

log

protected void log(String message,
                   LogLevel level)