rsb.transport.socket

Class BusCache

java.lang.Object

rsb.transport.socket.BusCache

public class BusCache
extends Object

A cache for Bus instances based on the required SocketOptions . This class is thread-safe. For longer synchronized blocks use getSynchronizer().

Author:

jwienke

Constructor Summary

Constructors

Constructor and Description
BusCache()

Method Summary

Methods

Modifier and Type	Method and Description
Bus	get(SocketOptions options) Returns a Bus instance for the given options or null if no such instance is cached.
Object	getSynchronizer() Clients may use the returned instance to synchronize on.
boolean	hasBus(SocketOptions options) Indicates whether a Bus instance with the given options is available or not.
void	register(Bus bus) Registers a new bus instance in the cache.
void	register(Bus bus, boolean replace) Registers a new bus instance in the cache and allows overriding existing instances.
void	unregister(Bus bus) Removes a bus from the cache if it was present.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusCache

public BusCache()

Method Detail

getSynchronizer

public Object getSynchronizer()

Clients may use the returned instance to synchronize on.

Returns:

object to synchronize on

register

public void register(Bus bus)

Registers a new bus instance in the cache.

Parameters:

bus - bus to register

Throws:

IllegalArgumentException - there is already a bus with the given options

register

public void register(Bus bus,
            boolean replace)

Registers a new bus instance in the cache and allows overriding existing instances.

Parameters:

bus - bus to registers

replace - if true, replace existing instances with the same options instead of throwing an exception

Throws:

IllegalArgumentException - there is already a bus with the given options and replacing was not requested

unregister

public void unregister(Bus bus)

Removes a bus from the cache if it was present.

Parameters:

bus - the bus to remove

get

public Bus get(SocketOptions options)

Returns a Bus instance for the given options or null if no such instance is cached.

Parameters:

options - options to look up

Returns:

Bus instance or null

hasBus

public boolean hasBus(SocketOptions options)

Indicates whether a Bus instance with the given options is available or not.

Parameters:

options - options to look up

Returns:

true if available, else false