SSDPMessage (repo.hcf.dev/javadoc/ball-api 20200622.0 API)

All Superinterfaces:

HttpMessage

All Known Implementing Classes:

SSDPDiscoveryRequest, SSDPNotifyRequest, SSDPRequest, SSDPResponse
```
public interface SSDPMessage
extends HttpMessage
```
SSDP HttpMessage interface definition.

Version:

$Revision: 5285 $

Author:

Allen D. Ball

Field Summary

Fields
Modifier and Type	Field and Description
`static InetSocketAddress`	`ADDRESS` SSDP IPv4 broadcast address
`static String`	`AL` SSDP message header name
`static Charset`	`CHARSET` SSDP `Charset`
`static String`	`CRLF` `SSDPMessage` end-of-line sequence.
`static String`	`EXT` SSDP message header name
`static String`	`MAN` SSDP message header name
`static String`	`MAX_AGE` HTTP cache control key
`static String`	`MX` SSDP message header name
`static String`	`NT` SSDP message header name
`static String`	`NTS` SSDP message header name
`static String`	`SSDP_ALIVE` SSDP `NTS` value
`static String`	`SSDP_BYEBYE` SSDP `NTS` value
`static String`	`ST` SSDP message header name
`static String`	`USN` SSDP message header name

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default URI`	`getLocation()` Method to get the service location.
`default URI`	`getST()` Method to get the service type ("ST").
`default URI`	`getUSN()` Method to get the "USN" `URI`.
`default DatagramPacket`	`toDatagramPacket()` Method to encode `this` `SSDPMessage` to a `DatagramPacket`.

Methods inherited from interface org.apache.http.HttpMessage
addHeader, addHeader, containsHeader, getAllHeaders, getFirstHeader, getHeaders, getLastHeader, getParams, getProtocolVersion, headerIterator, headerIterator, removeHeader, removeHeaders, setHeader, setHeader, setHeaders, setParams

- Field Detail
  - CHARSET
```
static final Charset CHARSET
```
    SSDP Charset
  - ADDRESS
```
static final InetSocketAddress ADDRESS
```
    SSDP IPv4 broadcast address
  - AL
```
static final String AL
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - EXT
```
static final String EXT
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - MAN
```
static final String MAN
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - MX
```
static final String MX
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - NT
```
static final String NT
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - NTS
```
static final String NTS
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - ST
```
static final String ST
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - USN
```
static final String USN
```
    SSDP message header name
    
    See Also:
    
    Constant Field Values
  - SSDP_ALIVE
```
static final String SSDP_ALIVE
```
    SSDP NTS value
    
    See Also:
    
    Constant Field Values
  - SSDP_BYEBYE
```
static final String SSDP_BYEBYE
```
    SSDP NTS value
    
    See Also:
    
    Constant Field Values
  - MAX_AGE
```
static final String MAX_AGE
```
    HTTP cache control key
    
    See Also:
    
    Constant Field Values
  - CRLF
```
static final String CRLF
```
    SSDPMessage end-of-line sequence.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getLocation
```
default URI getLocation()
```
    Method to get the service location.
    
    Returns:
    
    The service location URI.
  - getST
```
default URI getST()
```
    Method to get the service type ("ST").
    
    Returns:
    
    The service type URI.
  - getUSN
```
default URI getUSN()
```
    Method to get the "USN" URI.
    
    Returns:
    
    The "USN" URI.
  - toDatagramPacket
```
default DatagramPacket toDatagramPacket()
                                 throws SocketException
```
    Method to encode this SSDPMessage to a DatagramPacket.
    
    Returns:
    
    The DatagramPacket.
    
    Throws:
    
    SocketException - If this SSDPMessage cannot be converted to a DatagramPacket.
    
    See Also:
    
    ADDRESS

Interface SSDPMessage

Field Summary

Method Summary

Methods inherited from interface org.apache.http.HttpMessage

Field Detail

CHARSET

ADDRESS

AL

EXT

MAN

MX

NT

NTS

ST

USN

SSDP_ALIVE

SSDP_BYEBYE

MAX_AGE

CRLF

Method Detail

getLocation

getST

getUSN

toDatagramPacket