EBF_pkt.ih File Reference
Defines the inlines associated with the packet header.
More...
#include <EDS/EBF_pkt.h>
#include <EDS/EBF_edw.h>
#include <EDS/EBF_ebw.h>
Detailed Description
Defines the inlines associated with the packet header.
packet.
- Author:
- JJRussell - russell@slac.stanford.edu
CVS $Id: EBF_pkt.ih,v 1.3 2011/03/25 22:16:55 russell Exp $
- The inlines defined in this file reference the LCBD private data. They are meant to be used only went writing IO for EBF streams. They must not be used in general purpose code since they depend on knowledge about the driver.
Function Documentation
static __inline EBF_pkt * EBF__pktNext |
( |
const EBF_pkt * |
pkt |
) |
[static] |
Returns a pointer to the next packet.
- Returns:
- Pointer to the current packet
- Parameters:
-
| pkt | Pointer to the current packet |
- Note:
- This function is useful only when going through a list of packets from the EBF_fileIn routines, that is, mainly in test programs. The LCB driver provides this functionality in the real system, handing the user a new event descriptor when a new packet is available.
- Warning:
- Note that this routine makes no guarantee that there is a next packet. It merely advances the pointer to one past the end of the base packet.
References EBF__pktSize().
static __inline int EBF__pktSize |
( |
const EBF_pkt * |
pkt |
) |
[static] |
Returns the size in bytes, of the specified packet.
- Returns:
- The size in bytes, of the specified packet
- See also:
- EBF__pktAdvance
- Parameters:
-
- Note:
- This is the total size, in bytes, of the packet, i.e. the fixed sized header plus the data portion. Adding this byte count to the pointer of beginning of the packet will advance the beginning packet to the end of the packet.
References _EBF_edw::bf, EBF_EDW_LEN_TO_BYTES, _EBF_pkt::hdr, _EBF_edw_bf::len, _EBF_edw::ui, and _EBF_pktHdr::undef.
Referenced by EBF__pktNext().