SSDPSearchResponseSocket

java.lang.Object

org.cybergarage.upnp.ssdp.HTTPUSocket

org.cybergarage.upnp.ssdp.SSDPSearchResponseSocket

All Implemented Interfaces:: Runnable

public class SSDPSearchResponseSocketextends HTTPUSocket implements Runnable

Socket for receiving SSDP search responses from UPnP devices.

This class extends HTTPUSocket and implements Runnable to provide asynchronous handling of SSDP search responses. It listens for responses to M-SEARCH messages sent during device discovery operations.

Key features:

Asynchronous response reception
SSDP search response parsing
Multi-threaded operation
Network interface binding
Control point notification

This class is used by UPnP control points to receive responses from devices when performing device discovery searches. It runs in a separate thread to continuously listen for incoming search responses without blocking the main application.

Constructor Summary
Constructors
Constructor
Description
SSDPSearchResponseSocket()
Bind a search response socket to the default address and port.
SSDPSearchResponseSocket(String bindAddr, int port)
Bind a search response socket to the given address and port.
Method Summary
All Methods
Modifier and Type
Method
Description
ControlPoint
getControlPoint()
The control point this socket reports search results to.
boolean
post(String addr, int port, SSDPSearchRequest req)
Send a search request to the given address.
boolean
post(String addr, int port, SSDPSearchResponse res)
Send a search response back to the requester.
void
run()
Watch for inbound search requests and answer them.
void
setControlPoint(ControlPoint ctrlp)
Attach the control point this socket reports search results to.
void
start()
Start the response thread.
void
stop()
Stop the response thread.
Methods inherited from class HTTPUSocket
close, finalize, getDatagramSocket, getLocalAddress, getUDPSocket, open, open, open, post, receive, setLocalAddress, toString
Modifier and Type
Method
Description
boolean
close()
Close the socket and clear the reference to it.
protected void
finalize()
Close the socket when the object is garbage collected.
DatagramSocket
getDatagramSocket()
Open a datagram socket on an ephemeral port, for SSDP unicast traffic.
String
getLocalAddress()
Return the local address this socket reports.
DatagramSocket
getUDPSocket()
Return the underlying datagram socket, for callers that need it directly.
boolean
open()
Open a datagram socket on an ephemeral port, replacing any open socket.
boolean
open(int bindPort)
Open a datagram socket bound to a local port with address reuse allowed.
boolean
open(String bindAddr, int bindPort)
Open a datagram socket bound to a local address and port.
boolean
post(String addr, int port, String msg)
Send one SSDP message as a UDP datagram.
SSDPPacket
receive()
Block until one datagram arrives, then wrap it as an SSDP packet.
void
setLocalAddress(String addr)
Override the address this socket reports as its own.
String
toString()
Return the local address this socket reports.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SSDPSearchResponseSocket
  public SSDPSearchResponseSocket()
  Bind a search response socket to the default address and port.
- SSDPSearchResponseSocket
  public SSDPSearchResponseSocket(String bindAddr, int port)
  Bind a search response socket to the given address and port.
  Parameters:
  bindAddr - the address to bind to
  port - the port to bind to
Method Details
- setControlPoint
  public void setControlPoint(ControlPoint ctrlp)
  Attach the control point this socket reports search results to.
  Parameters:
  ctrlp - the control point, may be null
- getControlPoint
  public ControlPoint getControlPoint()
  The control point this socket reports search results to.
  Returns:
  the control point, null when none is attached
- run
  public void run()
  Watch for inbound search requests and answer them.
  Specified by:
  run in interface Runnable
- start
  public void start()
  Start the response thread.
- stop
  public void stop()
  Stop the response thread.
- post
  public boolean post(String addr, int port, SSDPSearchResponse res)
  Send a search response back to the requester.
  Parameters:
  addr - the address to send to
  port - the port to send to
  res - the response to send
  Returns:
  true if the datagram was sent
- post
  public boolean post(String addr, int port, SSDPSearchRequest req)
  Send a search request to the given address.
  Parameters:
  addr - the address to send to
  port - the port to send to
  req - the request to send
  Returns:
  true if the datagram was sent

Constructor Summary

Method Summary

Methods inherited from class HTTPUSocket

Methods inherited from class Object

Constructor Details

SSDPSearchResponseSocket

Method Details

setControlPoint

getControlPoint

run

start

stop

post

post