pips_delete_publication()

Delete a publication

Synopsis:

#include <pips/publication.h>

int pips_delete_publication(pips_publication_t **publication)

Arguments:

publication: The address of a pointer to a publication instance. The pointer will be set to NULL before this function returns.

Library:

pips-client

Description:

This function cleans up any resources allocated to the given publication, then deletes the publication itself. These resources include those allocated by the provider to support publish-subscribe communication on the associated middleware.

This function does not, however, delete the topic associated with the publication. This can be done by calling pips_delete_topic().

Prerequisites

The publication must have been allocated using one of the PiPS publication creation functions. Otherwise, the cleanup may be incomplete or cause undefined behavior.

Returns:

EOK: The publication was successfully deleted

-1: An error occured (errno is set)

Errors:

The following errors can be generated by the framework:

EINVAL: The publication is invalid.
ENODEV: The publication has no associated provider.
ENOSYS: The provider doesn't implement the delete publication function.

Additional error codes may be set by the provider implementation.