gm_next_event_peek.c File Reference

#include "gm_internal.h"

Functions
GM_ENTRY_POINT int	gm_next_event_peek (gm_port_t *p, gm_u16_t *sender)

---

Detailed Description

This file contains the GM API function gm_next_event_peek().

---

Function Documentation

GM_ENTRY_POINT int gm_next_event_peek (  gm_port_t *  p, gm_u16_t *  sender )

gm_next_event_peek() returns the nonzero event type if an event is pending. If the event is a message receive event, then the sender parameter will be filled with the gmID of the message sender. If an event is pending a call to any gm_receive*() function will return the event immediately, although gm_receive() is preferred in this case for efficiency. Return values: gm_recv_event_t  Receive event type. Parameters: p  (IN) The GM port for which the communication is received. sender  See also: gm_receive_pending gm_receive Author: Glenn Brown Version: GM_API_VERSION (as defined in gm.h)

---