mUPnP for C
Macros | Typedefs | Functions
ssdp.h File Reference
#include <mupnp/typedef.h>
#include <mupnp/http/http.h>
#include <mupnp/net/socket.h>

Macros

#define MUPNP_SSDP_PORT   1900
 
#define MUPNP_SSDP_ADDRESS   "239.255.255.250"
 
#define MUPNP_SSDP_MULTICAST_ADDRESS   "239.255.255.250:1900"
 
#define MUPNP_AUTO_IP_NET   0xa9fe0000
 
#define MUPNP_AUTO_IP_MASK   0xffff0000
 
#define MUPNP_SSDP_MULTICAST_DEFAULT_TTL   4
 
#define MUPNP_SSDP_IPV6_IF_LOCAL_ADDRESS   "FF01::C"
 
#define MUPNP_SSDP_IPV6_LINK_LOCAL_ADDRESS   "FF02::C"
 
#define MUPNP_SSDP_IPV6_SUBNET_ADDRESS   "FF03::C"
 
#define MUPNP_SSDP_IPV6_ADMINISTRATIVE_ADDRESS   "FF04::C"
 
#define MUPNP_SSDP_IPV6_SITE_LOCAL_ADDRESS   "FF05::C"
 
#define MUPNP_SSDP_IPV6_GLOBAL_ADDRESS   "FF0E::C"
 
#define MUPNP_SSDP_DEFAULT_MSEARCH_MX   3
 
#define MUPNP_SSDP_DEFAULT_ANNOUNCE_COUNT   3
 
#define MUPNP_SSDP_HEADER_LINE_MAXSIZE   128
 
#define MUPNP_SSDP_ST   "ST"
 
#define MUPNP_SSDP_MX   "MX"
 
#define MUPNP_SSDP_MAN   "MAN"
 
#define MUPNP_SSDP_NT   "NT"
 
#define MUPNP_SSDP_NTS   "NTS"
 
#define MUPNP_SSDP_NTS_ALIVE   "ssdp:alive"
 
#define MUPNP_SSDP_NTS_BYEBYE   "ssdp:byebye"
 
#define MUPNP_SSDP_NTS_PROPCHANGE   "upnp:propchange"
 
#define MUPNP_SSDP_USN   "USN"
 
#define MUPNP_SSDP_EXT   "EXT"
 
#define MUPNP_SSDP_SID   "SID"
 
#define MUPNP_SSDP_SEQ   "SEQ"
 
#define MUPNP_SSDP_CALBACK   "CALLBACK"
 
#define MUPNP_SSDP_TIMEOUT   "TIMEOUT"
 
#define MUPNP_SSDP_SERVER   "SERVER"
 
#define MUPNP_SSDP_BOOTID_UPNP_ORG   "BOOTID.UPNP.ORG"
 
#define MUPNP_SSDP_FILTER_TABLE_SIZE   101
 
#define mupnp_ssdprequest_setmethod(ssdpReq, value)
 
#define mupnp_ssdprequest_getmethod(ssdpReq)
 
#define mupnp_ssdprequest_seturi(ssdpReq, value)
 
#define mupnp_ssdprequest_geturi(ssdpReq)
 
#define mupnp_ssdprequest_sethost(ssdpReq, addr, port)
 
#define mupnp_ssdprequest_gethost(ssdpReq)
 
#define mupnp_ssdprequest_setserver(ssdpReq, value)
 
#define mupnp_ssdprequest_getserver(ssdpReq)
 
#define mupnp_ssdprequest_setst(ssdpReq, value)
 
#define mupnp_ssdprequest_getst(ssdpReq)
 
#define mupnp_ssdprequest_setnt(ssdpReq, value)
 
#define mupnp_ssdprequest_getnt(ssdpReq)
 
#define mupnp_ssdprequest_setnts(ssdpReq, value)
 
#define mupnp_ssdprequest_getnts(ssdpReq)
 
#define mupnp_ssdprequest_setlocation(ssdpReq, value)
 
#define mupnp_ssdprequest_getlocation(ssdpReq)
 
#define mupnp_ssdprequest_setusn(ssdpReq, value)
 
#define mupnp_ssdprequest_getusn(ssdpReq)
 
#define mupnp_ssdprequest_setmx(ssdpReq, value)
 
#define mupnp_ssdprequest_getmx(ssdpReq)
 
#define mupnp_ssdprequest_setman(ssdpReq, value)
 
#define mupnp_ssdprequest_getman(ssdpReq)
 
#define mupnp_ssdprequest_setbootid(ssdpReq, value)
 
#define mupnp_ssdprequest_getbootid(ssdpReq)
 
#define mupnp_ssdprequest_print(ssdpReq)
 
#define mupnp_ssdpresponse_setst(ssdpRes, value)
 
#define mupnp_ssdpresponse_getst(ssdpRes)
 
#define mupnp_ssdpresponse_setext(ssdpRes)
 
#define mupnp_ssdpresponse_setserver(ssdpRes, value)
 
#define mupnp_ssdpresponse_setlocation(ssdpRes, value)
 
#define mupnp_ssdpresponse_getlocation(ssdpRes)
 
#define mupnp_ssdpresponse_setusn(ssdpRes, value)
 
#define mupnp_ssdpresponse_getusn(ssdpRes)
 
#define mupnp_ssdpresponse_setdate(ssdpRes, value)
 
#define mupnp_ssdpresponse_getdate(ssdpRes)
 
#define mupnp_ssdpresponse_setbootid(ssdpRes, value)
 
#define mupnp_ssdpresponse_getbootid(ssdpRes)
 
#define mupnp_ssdpresponse_print(ssdpReq)
 
#define mupnp_ssdp_socket_new()
 
#define mupnp_ssdp_socket_delete(socket)
 
#define mupnp_ssdp_socket_close(socket)
 

Typedefs

typedef mUpnpHttpResponse mUpnpSSDPResponse
 
typedef mUpnpHttpRequest mUpnpSSDPRequest
 
typedef mUpnpSocket mUpnpSSDPSocket
 

Functions

void mupnp_ssdp_setipv6address (const char *addr)
 Set the IPv6 multicast address for SSDP.
 
const char * mupnp_ssdp_getipv6address (void)
 Get the current IPv6 multicast address for SSDP.
 
void mupnp_ssdp_setannouncecount (int count)
 Set the number of times to send SSDP announcements.
 
int mupnp_ssdp_getannouncecount (void)
 Get the current SSDP announcement repetition count.
 
int mupnp_ssdp_getleasetime (const char *cacheCont)
 Extract lease time from a Cache-Control header value.
 
const char * mupnp_ssdp_gethostaddress (const char *ifAddr)
 Get the host address for a given network interface.
 
mUpnpSSDPRequest * mupnp_ssdprequest_new (void)
 Create a new SSDP request message.
 
void mupnp_ssdprequest_delete (mUpnpSSDPRequest *ssdpReq)
 Destroy an SSDP request message and free resources.
 
void mupnp_ssdprequest_setleasetime (mUpnpSSDPRequest *ssdpReq, mUpnpTime value)
 
mUpnpTime mupnp_ssdprequest_getleasetime (mUpnpSSDPRequest *ssdpReq)
 
char * mupnp_ssdprequest_tostring (mUpnpSSDPRequest *ssdpReq, mUpnpString *ssdpMsg)
 
mUpnpSSDPResponse * mupnp_ssdpresponse_new (void)
 
void mupnp_ssdpresponse_delete (mUpnpSSDPResponse *ssdpRes)
 
void mupnp_ssdpresponse_setleasetime (mUpnpSSDPResponse *ssdpRes, mUpnpTime value)
 
int mupnp_ssdpresponse_getleasetime (mUpnpSSDPResponse *ssdpRes)
 
char * mupnp_ssdpresponse_tostring (mUpnpSSDPResponse *ssdpRes, mUpnpString *ssdpMsg)
 
bool mupnp_ssdp_socket_notifyfrom (mUpnpSSDPSocket *ssdpSock, mUpnpSSDPRequest *ssdpReq, const char *bindAddr)
 
bool mupnp_ssdp_socket_postresponse (mUpnpSSDPSocket *ssdpSock, mUpnpSSDPResponse *ssdpReq, const char *host, int port)
 

Macro Definition Documentation

◆ MUPNP_AUTO_IP_MASK

#define MUPNP_AUTO_IP_MASK   0xffff0000

◆ MUPNP_AUTO_IP_NET

#define MUPNP_AUTO_IP_NET   0xa9fe0000

◆ MUPNP_SSDP_ADDRESS

#define MUPNP_SSDP_ADDRESS   "239.255.255.250"

◆ MUPNP_SSDP_BOOTID_UPNP_ORG

#define MUPNP_SSDP_BOOTID_UPNP_ORG   "BOOTID.UPNP.ORG"

◆ MUPNP_SSDP_CALBACK

#define MUPNP_SSDP_CALBACK   "CALLBACK"

◆ MUPNP_SSDP_DEFAULT_ANNOUNCE_COUNT

#define MUPNP_SSDP_DEFAULT_ANNOUNCE_COUNT   3

◆ MUPNP_SSDP_DEFAULT_MSEARCH_MX

#define MUPNP_SSDP_DEFAULT_MSEARCH_MX   3

◆ MUPNP_SSDP_EXT

#define MUPNP_SSDP_EXT   "EXT"

◆ MUPNP_SSDP_FILTER_TABLE_SIZE

#define MUPNP_SSDP_FILTER_TABLE_SIZE   101

◆ MUPNP_SSDP_HEADER_LINE_MAXSIZE

#define MUPNP_SSDP_HEADER_LINE_MAXSIZE   128

◆ MUPNP_SSDP_IPV6_ADMINISTRATIVE_ADDRESS

#define MUPNP_SSDP_IPV6_ADMINISTRATIVE_ADDRESS   "FF04::C"

◆ MUPNP_SSDP_IPV6_GLOBAL_ADDRESS

#define MUPNP_SSDP_IPV6_GLOBAL_ADDRESS   "FF0E::C"

◆ MUPNP_SSDP_IPV6_IF_LOCAL_ADDRESS

#define MUPNP_SSDP_IPV6_IF_LOCAL_ADDRESS   "FF01::C"

◆ MUPNP_SSDP_IPV6_LINK_LOCAL_ADDRESS

#define MUPNP_SSDP_IPV6_LINK_LOCAL_ADDRESS   "FF02::C"

◆ MUPNP_SSDP_IPV6_SITE_LOCAL_ADDRESS

#define MUPNP_SSDP_IPV6_SITE_LOCAL_ADDRESS   "FF05::C"

◆ MUPNP_SSDP_IPV6_SUBNET_ADDRESS

#define MUPNP_SSDP_IPV6_SUBNET_ADDRESS   "FF03::C"

◆ MUPNP_SSDP_MAN

#define MUPNP_SSDP_MAN   "MAN"

◆ MUPNP_SSDP_MULTICAST_ADDRESS

#define MUPNP_SSDP_MULTICAST_ADDRESS   "239.255.255.250:1900"

◆ MUPNP_SSDP_MULTICAST_DEFAULT_TTL

#define MUPNP_SSDP_MULTICAST_DEFAULT_TTL   4

◆ MUPNP_SSDP_MX

#define MUPNP_SSDP_MX   "MX"

◆ MUPNP_SSDP_NT

#define MUPNP_SSDP_NT   "NT"

◆ MUPNP_SSDP_NTS

#define MUPNP_SSDP_NTS   "NTS"

◆ MUPNP_SSDP_NTS_ALIVE

#define MUPNP_SSDP_NTS_ALIVE   "ssdp:alive"

◆ MUPNP_SSDP_NTS_BYEBYE

#define MUPNP_SSDP_NTS_BYEBYE   "ssdp:byebye"

◆ MUPNP_SSDP_NTS_PROPCHANGE

#define MUPNP_SSDP_NTS_PROPCHANGE   "upnp:propchange"

◆ MUPNP_SSDP_PORT

#define MUPNP_SSDP_PORT   1900

◆ MUPNP_SSDP_SEQ

#define MUPNP_SSDP_SEQ   "SEQ"

◆ MUPNP_SSDP_SERVER

#define MUPNP_SSDP_SERVER   "SERVER"

◆ MUPNP_SSDP_SID

#define MUPNP_SSDP_SID   "SID"

◆ mupnp_ssdp_socket_close

#define mupnp_ssdp_socket_close ( socket)
Value:
mupnp_socket_close(socket)
mupnp_socket_close
bool mupnp_socket_close(mUpnpSocket *sock)
Definition socket.c:318

◆ mupnp_ssdp_socket_delete

#define mupnp_ssdp_socket_delete ( socket)
Value:
mupnp_socket_delete(socket)
mupnp_socket_delete
bool mupnp_socket_delete(mUpnpSocket *sock)
Definition socket.c:254

◆ mupnp_ssdp_socket_new

#define mupnp_ssdp_socket_new ( )
Value:
mupnp_socket_new(MUPNP_NET_SOCKET_DGRAM)
mupnp_socket_new
mUpnpSocket * mupnp_socket_new(int type)
Definition socket.c:209
MUPNP_NET_SOCKET_DGRAM
#define MUPNP_NET_SOCKET_DGRAM
Definition socket.h:33

◆ MUPNP_SSDP_ST

#define MUPNP_SSDP_ST   "ST"

◆ MUPNP_SSDP_TIMEOUT

#define MUPNP_SSDP_TIMEOUT   "TIMEOUT"

◆ MUPNP_SSDP_USN

#define MUPNP_SSDP_USN   "USN"

◆ mupnp_ssdprequest_getbootid

#define mupnp_ssdprequest_getbootid ( ssdpReq)
Value:
mupnp_http_packet_getheaderinteger((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_BOOTID_UPNP_ORG)
mupnp_http_packet_getheaderinteger
int mupnp_http_packet_getheaderinteger(mUpnpHttpPacket *httpPkt, const char *name)
Definition http_packet.c:188
MUPNP_SSDP_BOOTID_UPNP_ORG
#define MUPNP_SSDP_BOOTID_UPNP_ORG
Definition ssdp.h:67
_mUpnpHttpPacket
Definition http.h:178

◆ mupnp_ssdprequest_gethost

#define mupnp_ssdprequest_gethost ( ssdpReq)
Value:
mupnp_http_packet_gethost((mUpnpHttpPacket*)ssdpReq)
mupnp_http_packet_gethost
#define mupnp_http_packet_gethost(httpPkt)
Definition http.h:323

◆ mupnp_ssdprequest_getlocation

#define mupnp_ssdprequest_getlocation ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_HTTP_LOCATION)
MUPNP_HTTP_LOCATION
#define MUPNP_HTTP_LOCATION
Definition http.h:85
mupnp_http_packet_getheadervalue
const char * mupnp_http_packet_getheadervalue(mUpnpHttpPacket *httpPkt, const char *name)
Definition http_packet.c:179

◆ mupnp_ssdprequest_getman

#define mupnp_ssdprequest_getman ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_MAN)
MUPNP_SSDP_MAN
#define MUPNP_SSDP_MAN
Definition ssdp.h:54

◆ mupnp_ssdprequest_getmethod

#define mupnp_ssdprequest_getmethod ( ssdpReq)
Value:
mupnp_http_request_getmethod(ssdpReq)
mupnp_http_request_getmethod
char * mupnp_http_request_getmethod(mUpnpHttpRequest *httpReq)
Definition http_request.c:182

◆ mupnp_ssdprequest_getmx

#define mupnp_ssdprequest_getmx ( ssdpReq)
Value:
mupnp_http_packet_getheaderinteger((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_MX)
MUPNP_SSDP_MX
#define MUPNP_SSDP_MX
Definition ssdp.h:53

◆ mupnp_ssdprequest_getnt

#define mupnp_ssdprequest_getnt ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_NT)
MUPNP_SSDP_NT
#define MUPNP_SSDP_NT
Definition ssdp.h:55

◆ mupnp_ssdprequest_getnts

#define mupnp_ssdprequest_getnts ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_NTS)
MUPNP_SSDP_NTS
#define MUPNP_SSDP_NTS
Definition ssdp.h:56

◆ mupnp_ssdprequest_getserver

#define mupnp_ssdprequest_getserver ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_HTTP_SERVER)
MUPNP_HTTP_SERVER
#define MUPNP_HTTP_SERVER
Definition http.h:86

◆ mupnp_ssdprequest_getst

#define mupnp_ssdprequest_getst ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_ST)
MUPNP_SSDP_ST
#define MUPNP_SSDP_ST
Definition ssdp.h:52

◆ mupnp_ssdprequest_geturi

#define mupnp_ssdprequest_geturi ( ssdpReq)
Value:
mupnp_http_request_geturi(ssdpReq)
mupnp_http_request_geturi
char * mupnp_http_request_geturi(mUpnpHttpRequest *httpReq)
Definition http_request.c:220

◆ mupnp_ssdprequest_getusn

#define mupnp_ssdprequest_getusn ( ssdpReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_USN)
MUPNP_SSDP_USN
#define MUPNP_SSDP_USN
Definition ssdp.h:60

◆ mupnp_ssdprequest_print

#define mupnp_ssdprequest_print ( ssdpReq)
Value:
mupnp_http_request_print(ssdpReq)
mupnp_http_request_print
void mupnp_http_request_print(mUpnpHttpRequest *httpReq)
Definition http_request.c:912

◆ mupnp_ssdprequest_setbootid

#define mupnp_ssdprequest_setbootid ( ssdpReq,
value )
Value:
mupnp_http_packet_setheaderinteger((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_BOOTID_UPNP_ORG, value)
mupnp_http_packet_setheaderinteger
void mupnp_http_packet_setheaderinteger(mUpnpHttpPacket *httpPkt, const char *name, int value)
Definition http_packet.c:119

◆ mupnp_ssdprequest_sethost

#define mupnp_ssdprequest_sethost ( ssdpReq,
addr,
port )
Value:
mupnp_http_packet_sethost((mUpnpHttpPacket*)ssdpReq, addr, port)
mupnp_http_packet_sethost
void mupnp_http_packet_sethost(mUpnpHttpPacket *httpPkt, const char *addr, int port)
Definition http_packet.c:256

◆ mupnp_ssdprequest_setlocation

#define mupnp_ssdprequest_setlocation ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_HTTP_LOCATION, value)
mupnp_http_packet_setheadervalue
void mupnp_http_packet_setheadervalue(mUpnpHttpPacket *httpPkt, const char *name, const char *value)
Definition http_packet.c:106

◆ mupnp_ssdprequest_setman

#define mupnp_ssdprequest_setman ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_MAN, value)

◆ mupnp_ssdprequest_setmethod

#define mupnp_ssdprequest_setmethod ( ssdpReq,
value )
Value:
mupnp_http_request_setmethod(ssdpReq, value)
mupnp_http_request_setmethod
void mupnp_http_request_setmethod(mUpnpHttpRequest *httpReq, const char *value)
Definition http_request.c:117

◆ mupnp_ssdprequest_setmx

#define mupnp_ssdprequest_setmx ( ssdpReq,
value )
Value:
mupnp_http_packet_setheaderinteger((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_MX, value)

◆ mupnp_ssdprequest_setnt

#define mupnp_ssdprequest_setnt ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_NT, value)

◆ mupnp_ssdprequest_setnts

#define mupnp_ssdprequest_setnts ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_NTS, value)

◆ mupnp_ssdprequest_setserver

#define mupnp_ssdprequest_setserver ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_HTTP_SERVER, value)

◆ mupnp_ssdprequest_setst

#define mupnp_ssdprequest_setst ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_ST, value)

◆ mupnp_ssdprequest_seturi

#define mupnp_ssdprequest_seturi ( ssdpReq,
value )
Value:
mupnp_http_request_seturi(ssdpReq, value)
mupnp_http_request_seturi
void mupnp_http_request_seturi(mUpnpHttpRequest *httpReq, const char *value)
Definition http_request.c:169

◆ mupnp_ssdprequest_setusn

#define mupnp_ssdprequest_setusn ( ssdpReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpReq, MUPNP_SSDP_USN, value)

◆ mupnp_ssdpresponse_getbootid

#define mupnp_ssdpresponse_getbootid ( ssdpRes)
Value:
mupnp_http_packet_getheaderinteger((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_BOOTID_UPNP_ORG)

◆ mupnp_ssdpresponse_getdate

#define mupnp_ssdpresponse_getdate ( ssdpRes)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_HTTP_DATE)
MUPNP_HTTP_DATE
#define MUPNP_HTTP_DATE
Definition http.h:74

◆ mupnp_ssdpresponse_getlocation

#define mupnp_ssdpresponse_getlocation ( ssdpRes)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_HTTP_LOCATION)

◆ mupnp_ssdpresponse_getst

#define mupnp_ssdpresponse_getst ( ssdpRes)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_ST)

◆ mupnp_ssdpresponse_getusn

#define mupnp_ssdpresponse_getusn ( ssdpRes)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_USN)

◆ mupnp_ssdpresponse_print

#define mupnp_ssdpresponse_print ( ssdpReq)
Value:
mupnp_http_response_print(ssdpReq)
mupnp_http_response_print
void mupnp_http_response_print(mUpnpHttpResponse *httpRes)
Definition http_response.c:217

◆ mupnp_ssdpresponse_setbootid

#define mupnp_ssdpresponse_setbootid ( ssdpRes,
value )
Value:
mupnp_http_packet_setheaderinteger((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_BOOTID_UPNP_ORG, value)

◆ mupnp_ssdpresponse_setdate

#define mupnp_ssdpresponse_setdate ( ssdpRes,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_HTTP_DATE, value)

◆ mupnp_ssdpresponse_setext

#define mupnp_ssdpresponse_setext ( ssdpRes)
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_EXT, "")
MUPNP_SSDP_EXT
#define MUPNP_SSDP_EXT
Definition ssdp.h:61

◆ mupnp_ssdpresponse_setlocation

#define mupnp_ssdpresponse_setlocation ( ssdpRes,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_HTTP_LOCATION, value)

◆ mupnp_ssdpresponse_setserver

#define mupnp_ssdpresponse_setserver ( ssdpRes,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_SERVER, value)
MUPNP_SSDP_SERVER
#define MUPNP_SSDP_SERVER
Definition ssdp.h:66

◆ mupnp_ssdpresponse_setst

#define mupnp_ssdpresponse_setst ( ssdpRes,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_ST, value)

◆ mupnp_ssdpresponse_setusn

#define mupnp_ssdpresponse_setusn ( ssdpRes,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)ssdpRes, MUPNP_SSDP_USN, value)

Typedef Documentation

◆ mUpnpSSDPRequest

typedef mUpnpHttpRequest mUpnpSSDPRequest

◆ mUpnpSSDPResponse

typedef mUpnpHttpResponse mUpnpSSDPResponse

◆ mUpnpSSDPSocket

typedef mUpnpSocket mUpnpSSDPSocket

Function Documentation

◆ mupnp_ssdp_getannouncecount()

int mupnp_ssdp_getannouncecount ( void )

Get the current SSDP announcement repetition count.

Returns
Number of times each announcement is sent. Default is MUPNP_SSDP_DEFAULT_ANNOUNCE_COUNT (3).
Note
Thread-safe: Can be called from any thread.
See also
mupnp_ssdp_setannouncecount()

◆ mupnp_ssdp_gethostaddress()

const char * mupnp_ssdp_gethostaddress ( const char * ifAddr)

Get the host address for a given network interface.

Retrieves the IP address of the specified network interface, suitable for use in SSDP messages (Location headers, etc.).

Parameters
ifAddrThe network interface address. May be NULL to use default.
Returns
The host address string, or NULL if not available.
Note
Thread-safe: Can be called from any thread.
The returned string is managed internally and should not be freed.

◆ mupnp_ssdp_getipv6address()

const char * mupnp_ssdp_getipv6address ( void )

Get the current IPv6 multicast address for SSDP.

Returns
The currently configured IPv6 multicast address. Default is MUPNP_SSDP_IPV6_LINK_LOCAL_ADDRESS.
Note
Thread-safe: Can be called from any thread.
See also
mupnp_ssdp_setipv6address()

◆ mupnp_ssdp_getleasetime()

int mupnp_ssdp_getleasetime ( const char * cacheCont)

Extract lease time from a Cache-Control header value.

Parses the Cache-Control header (or CACHE-CONTROL) from an SSDP message to extract the max-age directive, which specifies the device's lease time in seconds.

Example: "max-age=1800" returns 1800 (30 minutes).

Parameters
cacheContThe Cache-Control header value. May be NULL.
Returns
The lease time in seconds, or 0 if cacheCont is NULL or max-age directive is not found.
Note
Thread-safe: Can be called from any thread.

◆ mupnp_ssdp_setannouncecount()

void mupnp_ssdp_setannouncecount ( int count)

Set the number of times to send SSDP announcements.

Configures how many times each SSDP advertisement (alive or byebye) is sent. Multiple announcements increase reliability on unreliable networks. Default is MUPNP_SSDP_DEFAULT_ANNOUNCE_COUNT (3).

Parameters
countNumber of announcement repetitions. Must be >= 1. Typical values: 2-4. Higher values increase network traffic.
Note
Thread-safe: Should be called before starting devices.
Side effect: Changes the global announcement count setting.
See also
mupnp_ssdp_getannouncecount()

◆ mupnp_ssdp_setipv6address()

void mupnp_ssdp_setipv6address ( const char * addr)

Set the IPv6 multicast address for SSDP.

Configures the IPv6 multicast address used for SSDP discovery. Default is MUPNP_SSDP_IPV6_LINK_LOCAL_ADDRESS ("FF02::C").

Common IPv6 SSDP addresses:

  • FF01::C - Interface-local scope
  • FF02::C - Link-local scope (default, same subnet)
  • FF05::C - Site-local scope
  • FF0E::C - Global scope
Parameters
addrThe IPv6 multicast address. Must not be NULL. Should be one of the MUPNP_SSDP_IPV6_* constants.
Note
Thread-safe: Should be called before starting devices or control points.
Side effect: Changes the global IPv6 multicast address setting.
See also
mupnp_ssdp_getipv6address()

◆ mupnp_ssdp_socket_notifyfrom()

bool mupnp_ssdp_socket_notifyfrom ( mUpnpSSDPSocket * ssdpSock,
mUpnpSSDPRequest * ssdpReq,
const char * bindAddr )

◆ mupnp_ssdp_socket_postresponse()

bool mupnp_ssdp_socket_postresponse ( mUpnpSSDPSocket * ssdpSock,
mUpnpSSDPResponse * ssdpReq,
const char * host,
int port )

◆ mupnp_ssdprequest_delete()

void mupnp_ssdprequest_delete ( mUpnpSSDPRequest * ssdpReq)

Destroy an SSDP request message and free resources.

Releases all resources associated with the SSDP request, including header fields and message content.

Parameters
ssdpReqThe SSDP request to destroy. May be NULL (no-op if NULL).
Note
After calling this function, the ssdpReq pointer is invalid.
Thread-safe: Must not be called concurrently on the same request.
See also
mupnp_ssdprequest_new()

◆ mupnp_ssdprequest_getleasetime()

mUpnpTime mupnp_ssdprequest_getleasetime ( mUpnpSSDPRequest * ssdpReq)

◆ mupnp_ssdprequest_new()

mUpnpSSDPRequest * mupnp_ssdprequest_new ( void )

Create a new SSDP request message.

Allocates and initializes a new SSDP request object, which is used for:

  • M-SEARCH discovery requests
  • NOTIFY alive/byebye announcements

SSDP requests are HTTP-based messages sent over UDP multicast or unicast.

Returns
A newly-created mUpnpSSDPRequest on success, or NULL if memory allocation fails.
Note
The returned request must be freed with mupnp_ssdprequest_delete() when no longer needed.
Thread-safe: Can be called concurrently from multiple threads.
See also
mupnp_ssdprequest_delete()

◆ mupnp_ssdprequest_setleasetime()

void mupnp_ssdprequest_setleasetime ( mUpnpSSDPRequest * ssdpReq,
mUpnpTime value )

◆ mupnp_ssdprequest_tostring()

char * mupnp_ssdprequest_tostring ( mUpnpSSDPRequest * ssdpReq,
mUpnpString * ssdpMsg )

◆ mupnp_ssdpresponse_delete()

void mupnp_ssdpresponse_delete ( mUpnpSSDPResponse * ssdpRes)

◆ mupnp_ssdpresponse_getleasetime()

int mupnp_ssdpresponse_getleasetime ( mUpnpSSDPResponse * ssdpRes)

◆ mupnp_ssdpresponse_new()

mUpnpSSDPResponse * mupnp_ssdpresponse_new ( void )

◆ mupnp_ssdpresponse_setleasetime()

void mupnp_ssdpresponse_setleasetime ( mUpnpSSDPResponse * ssdpRes,
mUpnpTime value )

◆ mupnp_ssdpresponse_tostring()

char * mupnp_ssdpresponse_tostring ( mUpnpSSDPResponse * ssdpRes,
mUpnpString * ssdpMsg )