ssdp_prober.h File Reference

#include <sys/socket.h>
#include "common_definitions.h"
#include "configuration.h"

Include dependency graph for ssdp_prober.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ssdp_prober_s

Typedefs
typedef struct ssdp_prober_s	ssdp_prober_s

Functions
const char *	ssdp_probe_message_create (void)
void	ssdp_prober_close (ssdp_prober_s *prober)
int	ssdp_prober_init (ssdp_prober_s *prober, configuration_s *conf)
int	ssdp_prober_start (ssdp_prober_s *prober, configuration_s *conf)

Detailed Description

The SSDP prober header file.

Copyright

2017 Andreas Bank, andre.nosp@m.as.m.nosp@m.ikael.nosp@m..ban.nosp@m.k@gma.nosp@m.il.c.nosp@m.om

Definition in file ssdp_prober.h.

Typedef Documentation

typedef struct ssdp_prober_s ssdp_prober_s

A container struct for the SSDP prober.

Function Documentation

const char* ssdp_probe_message_create

(

void

)

Create a standard SSDP probe message.

Returns

A string containing a SSDP search/probe message.

Definition at line 38 of file ssdp_prober.c.

void ssdp_prober_close

(

ssdp_prober_s *

prober

)

Close the passed SSDP prober.

Parameters

listener

The SSDP prober to close.

Definition at line 85 of file ssdp_prober.c.

int ssdp_prober_init	(	ssdp_prober_s *	prober,
		configuration_s *	conf
	)

Create a SSDP prober. It is used to probe/scan the network in order to discover the existing SSDP-capable devices on the network.

Parameters

prober	The prober to init.
conf	the global configuration.

Returns

0 on success, non-0 value on error.

Definition at line 42 of file ssdp_prober.c.

int ssdp_prober_start	(	ssdp_prober_s *	prober,
		configuration_s *	conf
	)

Tells the SSDP prober to probe/scan for SSDP-capable nodes.

Parameters

prober	The prober to start.
conf	The global configuration to use.

Returns

0 on success, non-0 value on error.

Definition at line 94 of file ssdp_prober.c.