ssdplib.h

原来由英特尔制定的UPnP SDK的

* Parameters:
*	IN SOCKET socket: SSDP socket
*
* Description:
*	This function reads the data from the ssdp socket.
*
* Returns: void
*	
***************************************************************************/
void readFromSSDPSocket(SOCKET socket);


/************************************************************************
* Function : ssdp_request_type1
*
* Parameters:
*	IN char *cmd: command came in the ssdp request
*
* Description:
*	This function figures out the type of the SSDP search in the
*	in the request.
*
* Returns: enum SsdpSearchType
*	return appropriate search type else returns SSDP_ERROR
***************************************************************************/
enum SsdpSearchType ssdp_request_type1(IN char *cmd);


/************************************************************************
* Function : ssdp_request_type
*
* Parameters:
*	IN char *cmd: command came in the ssdp request
*	OUT SsdpEvent *Evt: The event structure partially filled by
*		 this function.
*
* Description:
*	This function starts filling the SSDP event structure based upon the 
*	request received. 
*
* Returns: int
*	0 on success; -1 on error
***************************************************************************/
int ssdp_request_type(IN char * cmd, OUT SsdpEvent * Evt);


/************************************************************************
* Function : SearchByTarget
*
* Parameters:
*	IN int Mx:Number of seconds to wait, to collect all the	responses.
*	char *St: Search target.
*	void *Cookie: cookie provided by control point application. This
*		cokie will be returned to application in the callback.
*
* Description:
*	This function creates and send the search request for a specific URL.
*
* Returns: int
*	1 if successful else appropriate error
***************************************************************************/
int SearchByTarget(IN int Mx, IN char *St, IN void *Cookie);

/************************************************************************
* Function : DeviceAdvertisement
*
* Parameters:
*	IN char *DevType : type of the device
*	IN int RootDev   : flag to indicate if the device is root device
*	IN char *Udn     :
*	IN char *Location: Location URL.
*	IN int Duration  : Service duration in sec.
*
* Description:
*	This function creates the device advertisement request based on
*	the input parameter, and send it to the multicast channel.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int DeviceAdvertisement(
	IN char *DevType,
	IN int RootDev,
	IN char *Udn, 
	IN char *Location,
	IN int Duration);


/************************************************************************
* Function : DeviceShutdown
*
* Parameters:	
*	IN char *DevType: Device Type.
*	IN int RootDev:1 means root device.
*	IN char *Udn: Device UDN
*	IN char *_Server:
*	IN char *Location: Location URL
*	IN int Duration :Device duration in sec.
*
* Description:
*	This function creates a HTTP device shutdown request packet 
*	and sent it to the multicast channel through RequestHandler.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int DeviceShutdown(
	IN char *DevType, 
	IN int RootDev,
	IN char *Udn, 
	IN char *_Server, 
	IN char *Location, 
	IN int Duration);

/************************************************************************
* Function : DeviceReply
*
* Parameters:	
*	IN struct sockaddr_in * DestAddr:destination IP address.
*	IN char *DevType: Device type
*	IN int RootDev: 1 means root device 0 means embedded device.
*	IN char *Udn: Device UDN
*	IN char *Location: Location of Device description document.
*	IN int Duration :Life time of this device.
*
* Description:
*	This function creates the reply packet based on the input parameter, 
*	and send it to the client address given in its input parameter DestAddr.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int DeviceReply(
	IN struct sockaddr_in * DestAddr, 
	IN char *DevType, 
	IN int RootDev, 
	IN char *Udn, 
	IN char *Location, IN int  Duration);

/************************************************************************
* Function : SendReply
*
* Parameters:	
*	IN struct sockaddr_in * DestAddr:destination IP address.
*	IN char *DevType: Device type
*	IN int RootDev: 1 means root device 0 means embedded device.
*	IN char * Udn: Device UDN
*	IN char *_Server:
*	IN char *Location: Location of Device description document.
*	IN int Duration :Life time of this device.
*	IN int ByType:
*
* Description:
*	This function creates the reply packet based on the input parameter, 
*	and send it to the client addesss given in its input parameter DestAddr.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int SendReply(
	IN struct sockaddr_in * DestAddr, 
	IN char *DevType, 
	IN int RootDev, 
	IN char *Udn, 
	IN char *Location, 
	IN int Duration, 
	IN int ByType );

/************************************************************************
* Function : ServiceAdvertisement
*
* Parameters:	
*	IN char * Udn: Device UDN
*	IN char *ServType: Service Type.
*	IN char * Location: Location of Device description document.
*	IN int Duration :Life time of this device.
*
* Description:
*	This function creates the advertisement packet based 
*	on the input parameter, and send it to the multicast channel.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int ServiceAdvertisement(
	IN char *Udn, 
	IN char *ServType,
	IN char *Location,
	IN int Duration);

/************************************************************************
* Function : ServiceReply
*
* Parameters:	
*	IN struct sockaddr_in *DestAddr:
*	IN char *Udn: Device UDN
*	IN char *ServType: Service Type.
*	IN char *Server: Not used
*	IN char *Location: Location of Device description document.
*	IN int Duration :Life time of this device.
*
* Description:
*	This function creates the advertisement packet based 
*	on the input parameter, and send it to the multicast channel.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int ServiceReply(
	IN struct sockaddr_in *DestAddr,  
	IN char *ServType, 
	IN char *Udn, 
	IN char *Location,
	IN int Duration);

/************************************************************************
* Function : ServiceShutdown
*
* Parameters:
*	IN char *Udn: Device UDN
*	IN char *ServType: Service Type.
*	IN char *Location: Location of Device description document.
*	IN int Duration :Service duration in sec.
*
* Description:
*	This function creates a HTTP service shutdown request packet 
*	and sent it to the multicast channel through RequestHandler.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int ServiceShutdown(
	IN char *Udn,
	IN char *ServType,
	IN char *Location,
	IN int Duration);


/************************************************************************
* Function : advertiseAndReplyThread
*
* Parameters:
*	IN void *data: Structure containing the search request
*
* Description:
*	This function is a wrapper function to reply the search request 
*	coming from the control point.
*
* Returns: void *
*	always return NULL
***************************************************************************/
void *advertiseAndReplyThread(IN void * data);

/************************************************************************
* Function : AdvertiseAndReply
*
* Parameters:
*	IN int AdFlag: -1 = Send shutdown,
*			0 = send reply, 
*			1 = Send Advertisement
*	IN UpnpDevice_Handle Hnd: Device handle
*	IN enum SsdpSearchType SearchType:Search type for sending replies
*	IN struct sockaddr_in *DestAddr:Destination address
*	IN char *DeviceType:Device type
*	IN char *DeviceUDN:Device UDN
*	IN char *ServiceType:Service type
*	IN int Exp:Advertisement age
*
* Description:
*	This function to send SSDP advertisements, replies and shutdown messages.
*
* Returns: int
*	UPNP_E_SUCCESS if successful else appropriate error
***************************************************************************/
int AdvertiseAndReply(
	IN int AdFlag, 
	IN UpnpDevice_Handle Hnd, 
	IN enum SsdpSearchType SearchType, 
	IN struct sockaddr_in *DestAddr,
	IN char *DeviceType, 
	IN char *DeviceUDN, 
	IN char *ServiceType, int Exp);

#endif