org.teleal.cling.transport
Class SwitchableRouterImpl

java.lang.Object
  org.teleal.cling.transport.SwitchableRouterImpl

All Implemented Interfaces:

Router, SwitchableRouter

Direct Known Subclasses:

AndroidWifiSwitchableRouter

public class SwitchableRouterImpl
extends Object
implements SwitchableRouter

Default implementation of switchable network message router.

This implementation is actually wrapping a regular RouterImpl, making it on/off switchable.

If the router can't be enabled (e.g. an exception occurs during socket binding), a warning log message will be printed. You can customize this behavior by overriding handleStartFailure(org.teleal.cling.transport.spi.InitializationException).

Author:

Christian Bauer

Constructor Summary

SwitchableRouterImpl(UpnpServiceConfiguration configuration, ProtocolFactory protocolFactory)

Method Summary

void	broadcast(byte[] bytes) Call this method to broadcast a UDP message to all hosts on the network.
boolean	disable()
boolean	enable()
List<NetworkAddress>	getActiveStreamServers(InetAddress preferredAddress)
UpnpServiceConfiguration	getConfiguration()
NetworkAddressFactory	getNetworkAddressFactory()
ProtocolFactory	getProtocolFactory()
void	handleStartFailure(InitializationException ex) Called by the SwitchableRouter.enable() method before it returns.
boolean	isEnabled()
void	received(IncomingDatagramMessage msg) This method is called internally by the transport layer when a datagram, either unicast or multicast, has been received.
void	received(UpnpStream stream) This method is called internally by the transport layer when a TCP stream connection has been made and a response has to be returned to the sender.
void	send(OutgoingDatagramMessage msg) Call this method to send a UDP datagram message.
StreamResponseMessage	send(StreamRequestMessage msg) Call this method to send a TCP (HTTP) stream message.
void	shutdown() Unbinds all sockets and stops all listening threads for datagrams and streams.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchableRouterImpl

public SwitchableRouterImpl(UpnpServiceConfiguration configuration,
                            ProtocolFactory protocolFactory)

Method Detail

getConfiguration

public UpnpServiceConfiguration getConfiguration()

Specified by:

getConfiguration in interface Router

Returns:

The configuration used by this router.

getProtocolFactory

public ProtocolFactory getProtocolFactory()

Specified by:

getProtocolFactory in interface Router

Returns:

The protocol factory used by this router.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface SwitchableRouter

enable

public boolean enable()

Specified by:

enable in interface SwitchableRouter

Returns:

true if the router was enabled. false if it's already running.

handleStartFailure

public void handleStartFailure(InitializationException ex)

Description copied from interface: SwitchableRouter

Called by the SwitchableRouter.enable() method before it returns.

Specified by:

handleStartFailure in interface SwitchableRouter

Parameters:

ex - The cause of the failure.

disable

public boolean disable()

Specified by:

disable in interface SwitchableRouter

Returns:

true if the router was disabled. false if it wasn't running.

getNetworkAddressFactory

public NetworkAddressFactory getNetworkAddressFactory()

Specified by:

getNetworkAddressFactory in interface Router

Returns:

The network interface and address binding configuration of this router.

getActiveStreamServers

public List<NetworkAddress> getActiveStreamServers(InetAddress preferredAddress)

Specified by:

getActiveStreamServers in interface Router

Parameters:

preferredAddress - A preferred stream server bound address or null.

Returns:

An empty list if no stream server is currently active, otherwise a single network address if the preferred address is active, or a list of all active bound stream servers.

shutdown

public void shutdown()

Description copied from interface: Router

Unbinds all sockets and stops all listening threads for datagrams and streams.

Specified by:

shutdown in interface Router

received

public void received(IncomingDatagramMessage msg)

Description copied from interface: Router

This method is called internally by the transport layer when a datagram, either unicast or multicast, has been received. An implementation of this interface has to handle the received message, e.g. selecting and executing a UPnP protocol. This method should not block until the execution completes, the calling thread should be free to handle the next reception as soon as possible.

Specified by:

received in interface Router

Parameters:

msg - The received datagram message.

received

public void received(UpnpStream stream)

Description copied from interface: Router

This method is called internally by the transport layer when a TCP stream connection has been made and a response has to be returned to the sender. An implementation of this interface has to handle the received stream connection and return a response, e.g. selecting and executing a UPnP protocol. This method should not block until the execution completes, the calling thread should be free to process the next reception as soon as possible. Typically this means starting a new thread of execution in this method.

Specified by:

received in interface Router

send

public void send(OutgoingDatagramMessage msg)

Description copied from interface: Router

Call this method to send a UDP datagram message.

Specified by:

send in interface Router

Parameters:

msg - The UDP datagram message to send.

send

public StreamResponseMessage send(StreamRequestMessage msg)

Description copied from interface: Router

Call this method to send a TCP (HTTP) stream message.

Specified by:

send in interface Router

Parameters:

msg - The TCP (HTTP) stream message to send.

Returns:

The response received from the server.

broadcast

public void broadcast(byte[] bytes)

Description copied from interface: Router

Call this method to broadcast a UDP message to all hosts on the network.

Specified by:

broadcast in interface Router

Parameters:

bytes - The byte payload of the UDP datagram.