IP_IsPulse

IP_IsPulse — validates a received message against a pulse ID.

Syntax

#include <cogent.h>
int IP_IsPulse(int  pulse,
 int  rcvid,
 void*  msg);

Arguments

pulse

A pulse ID as generated by IP_PulseNew.

rcvid

The rcvid field from an IP_MsgInfo structure.

msg

The pointer to a message received through IP_Receive.

Returns

0 if the pulse does not correspond to the rcvid and msg, or non-zero if the rcvid and msg do represent the pulse.

Description

This function compares the rcvid and msg to the pulse, and determines whether they really represent an occurrence of the pulse.

See Also

Pulses and Timers