VIP_VI_QUEUE Struct Reference

#include <vipl_structs.h>

Data Fields
VIP_DESCRIPTOR *	first
VIP_DESCRIPTOR *	last
VIP_DESCRIPTOR *	current_desc
VIP_MEM_HANDLE	current_mem
VIP_UINT32	total_count
VIP_CQ *	vip_cq_ptr
VIP_ULONG	count_to_process
VIP_UINT32	event_count
VIP_EVENT_T	event
VIP_SEMAPHORE_T	notify_tokens
VIP_BOOLEAN	notify_initialized
VIP_BOOLEAN	notify_cancelled
VIP_THREAD_T	notify_thread
VIP_NOTIFY *	first_notify_handler
VIP_NOTIFY *	last_notify_handler

---

Detailed Description

A VI queue (send queue or receive queue) of a VI.

Definition at line 312 of file vipl_structs.h.

---

Field Documentation

VIP_DESCRIPTOR* VIP_VI_QUEUE::first

Pointer to the first descriptor of this queue. Definition at line 315 of file vipl_structs.h. Referenced by vip_is_first_desc_notified(), vip_notify_desc_completion(), vip_vi_transition_to_error_state(), VipCreateVi(), VipRecvWait(), and VipSendWait().

VIP_DESCRIPTOR* VIP_VI_QUEUE::last

Pointer to the last descriptor of this queue. Definition at line 317 of file vipl_structs.h. Referenced by vip_vi_transition_to_error_state(), VipCreateVi(), VipRecvWait(), and VipSendWait().

VIP_DESCRIPTOR* VIP_VI_QUEUE::current_desc

Pointer to the current descriptor to use, to send or recv. Definition at line 319 of file vipl_structs.h. Referenced by vip_handle_3way_done(), vip_handle_3way_ok(), vip_handle_matching_message(), vip_handle_put_done(), vip_handle_put_ok(), vip_notify_desc_completion(), vip_process_send_desc(), vip_resume_callback(), vip_vi_transition_to_error_state(), VipCreateVi(), and VipSendWait().

VIP_MEM_HANDLE VIP_VI_QUEUE::current_mem

Memory handle of the current descriptor to use, to send or recv. Definition at line 321 of file vipl_structs.h. Referenced by vip_handle_3way_done(), vip_handle_matching_message(), vip_handle_put_done(), vip_notify_desc_completion(), vip_process_send_desc(), vip_resume_callback(), vip_vi_transition_to_error_state(), VipCreateVi(), and VipSendWait().

VIP_UINT32 VIP_VI_QUEUE::total_count

Total number of descriptor in this queue, completed or not. Definition at line 323 of file vipl_structs.h. Referenced by VipCreateVi(), VipRecvNotify(), VipRecvWait(), VipSendNotify(), and VipSendWait().

VIP_CQ* VIP_VI_QUEUE::vip_cq_ptr

Completion queue associated with this queue, if defined. Definition at line 325 of file vipl_structs.h. Referenced by vip_destroy_vi_handle_set(), vip_notify_desc_completion(), vip_vi_transition_to_error_state(), VipCreateVi(), VipRecvNotify(), VipRecvWait(), VipSendNotify(), and VipSendWait().

VIP_ULONG VIP_VI_QUEUE::count_to_process

Number of descriptor not completed in the queue. Definition at line 327 of file vipl_structs.h. Referenced by vip_handle_3way_done(), vip_handle_matching_message(), vip_handle_put_done(), vip_process_send_desc(), vip_resume_callback(), vip_vi_transition_to_error_state(), and VipCreateVi().

VIP_UINT32 VIP_VI_QUEUE::event_count

Number of threads blocked on the previous event variable. Definition at line 329 of file vipl_structs.h. Referenced by vip_notify_desc_completion(), vip_vi_transition_to_error_state(), VipCreateVi(), VipRecvWait(), and VipSendWait().

VIP_EVENT_T VIP_VI_QUEUE::event

Event variable used to wake up threads blocking on the VI. Definition at line 331 of file vipl_structs.h. Referenced by vip_destroy_vi_handle_set(), vip_notify_desc_completion(), vip_vi_transition_to_error_state(), VipCreateVi(), VipRecvWait(), and VipSendWait().

VIP_SEMAPHORE_T VIP_VI_QUEUE::notify_tokens

Semaphore used to trigger the activity of the notify thread. Definition at line 333 of file vipl_structs.h. Referenced by vip_recv_notify_thread(), vip_send_notify_thread(), VipCreateVi(), VipRecvNotify(), and VipSendNotify().

VIP_BOOLEAN VIP_VI_QUEUE::notify_initialized

Flag indicating if the notify thread is spawned. Definition at line 335 of file vipl_structs.h. Referenced by VipCreateVi(), VipRecvNotify(), and VipSendNotify().

VIP_BOOLEAN VIP_VI_QUEUE::notify_cancelled

Flag indicating if the notify thread should be stopped. Definition at line 337 of file vipl_structs.h. Referenced by vip_recv_notify_thread(), vip_send_notify_thread(), and VipCreateVi().

VIP_THREAD_T VIP_VI_QUEUE::notify_thread

Notify thread blocking on the queue and executing the handlers. Definition at line 339 of file vipl_structs.h. Referenced by VipRecvNotify(), and VipSendNotify().

struct VIP_NOTIFY* VIP_VI_QUEUE::first_notify_handler

Pointer to the first registered notify handler in the pending list. Definition at line 341 of file vipl_structs.h. Referenced by VipCreateVi(), VipRecvNotify(), and VipSendNotify().

struct VIP_NOTIFY* VIP_VI_QUEUE::last_notify_handler

Pointer to the first registered notify handler in the pending list. Definition at line 343 of file vipl_structs.h. Referenced by VipCreateVi(), VipRecvNotify(), and VipSendNotify().

---

The documentation for this struct was generated from the following file:

• vipl_structs.h