|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Router
Interface of the network transport layer.
Encapsulates the transport layer and provides methods to the upper layers for
sending UPnP stream (HTTP) StreamRequestMessage
s,
sending (UDP) datagram OutgoingDatagramMessage
s,
as well as broadcasting bytes to all LAN participants.
A router also maintains listening sockets and services, for incoming UDP unicast/multicast
IncomingDatagramMessage
and TCP
UpnpStream
s. An implementation of this interface
handles these messages, e.g. by selecting and executing the right protocol.
ProtocolFactory
Method Summary | |
---|---|
void |
broadcast(byte[] bytes)
Call this method to broadcast a UDP message to all hosts on the network. |
List<NetworkAddress> |
getActiveStreamServers(InetAddress preferredAddress)
|
UpnpServiceConfiguration |
getConfiguration()
|
NetworkAddressFactory |
getNetworkAddressFactory()
|
ProtocolFactory |
getProtocolFactory()
|
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. |
Method Detail |
---|
UpnpServiceConfiguration getConfiguration()
ProtocolFactory getProtocolFactory()
NetworkAddressFactory getNetworkAddressFactory()
List<NetworkAddress> getActiveStreamServers(InetAddress preferredAddress)
preferredAddress
- A preferred stream server bound address or null
.
void shutdown()
void received(IncomingDatagramMessage msg)
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.
msg
- The received datagram message.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. 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.
stream
- void send(OutgoingDatagramMessage msg)
Call this method to send a UDP datagram message.
msg
- The UDP datagram message to send.StreamResponseMessage send(StreamRequestMessage msg)
Call this method to send a TCP (HTTP) stream message.
msg
- The TCP (HTTP) stream message to send.
void broadcast(byte[] bytes)
Call this method to broadcast a UDP message to all hosts on the network.
bytes
- The byte payload of the UDP datagram.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |