packet

March 26, 2020 Contributors

Name

packet

Synopsis

#include "hooks/publish/packet.h"

| void **packet** ( | closure, |   |
|   | source, |   |
|   | packet, |   |
|   | plen); |   |

void * <var class="pdparam">closure</var>;
char * <var class="pdparam">source</var>;
char * <var class="pdparam">packet</var>;
int <var class="pdparam">plen</var>;

| int **has_publish_packet_hook** ( | ); |   |

| void **register_publish_packet_hook_first** ( | hook, |   |
|   | closure); |   |

ec_hook_publish_packet_func_t <var class="pdparam">hook</var>;
void *<var class="pdparam">closure</var>;

| void **register_publish_packet_hook_last** ( | hook, |   |
|   | closure); |   |

ec_hook_publish_packet_func_t <var class="pdparam">hook</var>;
void *<var class="pdparam">closure</var>;

| void **call_publish_packet_hook** ( | source, |   |
|   | packet, |   |
|   | plen); |   |

char * <var class="pdparam">source</var>;
char * <var class="pdparam">packet</var>;
int <var class="pdparam">plen</var>;

Description

closure

the implementation specific closure, this is not needed for the hook’s caller.

source

a string containing the name of the source module from where the publish_packet hook is being called.

packet

a pointer to the buffer containing the data to be published

plen

an integer describing the length of the data in bytes.

Invoked when a module wants to publish information via spread to the cluster.