CyberLink for C

csubscription.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/http/chttp.h>

Defines

#define cg_upnp_event_subscription_request_delete(subReq)   cg_http_request_delete(subReq)
#define cg_upnp_event_subscription_request_sethost(subReq, ipaddr, port)   cg_http_request_sethost(subReq, ipaddr, port)
#define cg_upnp_event_subscription_request_gethost(subReq, value)   cg_http_request_gethost(subReq)
#define cg_upnp_event_subscription_request_setnt(subReq, value)   cg_http_request_setheadervalue(subReq, CG_HTTP_NT, value)
#define cg_upnp_event_subscription_request_getnt(subReq, value)   cg_http_request_getheadervalue(subReq, CG_HTTP_NT)
#define cg_upnp_event_subscription_request_setcallback(subReq, value)   cg_http_request_setheadervalue(subReq, CG_HTTP_CALLBACK, value)
#define cg_upnp_event_subscription_request_getcallback(subReq, value)   cg_http_request_getheadervalue(subReq, CG_HTTP_CALLBACK)
#define cg_upnp_event_subscription_request_setsid(subReq, value)   cg_http_request_setheadervalue(subReq, CG_HTTP_SID, value)
#define cg_upnp_event_subscription_request_getsid(subReq, value)   cg_http_request_getheadervalue(subReq, CG_HTTP_SID)

Typedefs

typedef CgHttpRequest CgUpnpSubscriptionRequest

Functions

CgUpnpSubscriptionRequest * cg_upnp_event_subscription_request_new ()
void cg_upnp_event_subscription_request_settimeout (CgUpnpSubscriptionRequest *subReq, long timeout)
long cg_upnp_event_subscription_request_gettimeout (CgUpnpSubscriptionRequest *subReq)

Define Documentation

#define cg_upnp_event_subscription_request_delete (   subReq)    cg_http_request_delete(subReq)

Delete subscription request

Parameters:
subReqsubscription request
#define cg_upnp_event_subscription_request_getcallback (   subReq,
  value 
)    cg_http_request_getheadervalue(subReq, CG_HTTP_CALLBACK)

Get callback url from subscription request

Subscription request Not actually used anywhere

Bug:
Value not needed here!
#define cg_upnp_event_subscription_request_gethost (   subReq,
  value 
)    cg_http_request_gethost(subReq)

Get host header value from subscription request

Parameters:
subReqSubscription request
valueNot actually used anywhere
Bug:
Value not needed here! (It is even processed out from to be compiled code)
#define cg_upnp_event_subscription_request_getnt (   subReq,
  value 
)    cg_http_request_getheadervalue(subReq, CG_HTTP_NT)

Get NT from subscription request

Parameters:
subReqSubscription request
valueNot actually used anywhere
Bug:
Value not needed here!
#define cg_upnp_event_subscription_request_getsid (   subReq,
  value 
)    cg_http_request_getheadervalue(subReq, CG_HTTP_SID)

Get SID from subscription request object

Parameters:
subReqSubscription request
valueNot used
Bug:
Value not needed here!
#define cg_upnp_event_subscription_request_setcallback (   subReq,
  value 
)    cg_http_request_setheadervalue(subReq, CG_HTTP_CALLBACK, value)

Set callback URL for eventing

Parameters:
subReqSubscription request value String which defines the callback URL
#define cg_upnp_event_subscription_request_sethost (   subReq,
  ipaddr,
  port 
)    cg_http_request_sethost(subReq, ipaddr, port)

Set host header value into underlying HTTP packet

Parameters:
subReqSubscription request
ipaddrHost ip address
portHost port
#define cg_upnp_event_subscription_request_setnt (   subReq,
  value 
)    cg_http_request_setheadervalue(subReq, CG_HTTP_NT, value)

Set NT (Notification type) for subscription request

Parameters:
subReqSubscription request
valueNotification type
#define cg_upnp_event_subscription_request_setsid (   subReq,
  value 
)    cg_http_request_setheadervalue(subReq, CG_HTTP_SID, value)

Set SID (Subscription ID) for subscription request

Parameters:
subReqSubscription request
valueSID

Typedef Documentation

Data type for subscription request


Function Documentation

long cg_upnp_event_subscription_request_gettimeout ( CgUpnpSubscriptionRequest *  subReq)

Get timeout value from subscription request

Parameters:
subReqSubscription request
Returns:
Timeout
CgUpnpSubscriptionRequest* cg_upnp_event_subscription_request_new ( )

Create new subscription request

void cg_upnp_event_subscription_request_settimeout ( CgUpnpSubscriptionRequest *  subReq,
long  timeout 
)

Set timeout for subscription request

Parameters:
subReqSubscription request
timeoutTimeout

Set timeout for subscription request

Parameters:
subReqSubscription request
timeoutTimeout value for subscription request