Arcane::MessagePassing::IAsyncQueue Class Reference

Asynchronous queue allowing the exchange of information between threads. More...

#include <arcane/parallel/thread/IAsyncQueue.h>

Inheritance diagram for Arcane::MessagePassing::IAsyncQueue:

Collaboration diagram for Arcane::MessagePassing::IAsyncQueue:

Public Member Functions
virtual void	push (void *v)=0
	Adds v to the queue.
virtual void *	pop ()=0
	Retrieves the first value from the queue and blocks if there are none.
virtual void *	tryPop ()=0
	Retrieves the first value if available. Returns nullptr otherwise.

Static Public Member Functions
static IAsyncQueue *	createQueue ()

Detailed Description

Asynchronous queue allowing the exchange of information between threads.

Definition at line 32 of file IAsyncQueue.h.

Member Function Documentation

createQueue()

IAsyncQueue * Arcane::MessagePassing::IAsyncQueue::createQueue ( )

static

Definition at line 128 of file AsyncQueue.cc.

pop()

virtual void * Arcane::MessagePassing::IAsyncQueue::pop ( )

pure virtual

Retrieves the first value from the queue and blocks if there are none.

Implemented in Arcane::MessagePassing::SharedMemoryBasicAsyncQueue.

push()

virtual void Arcane::MessagePassing::IAsyncQueue::push ( void * v )

pure virtual

Adds v to the queue.

Implemented in Arcane::MessagePassing::SharedMemoryBasicAsyncQueue.

tryPop()

virtual void * Arcane::MessagePassing::IAsyncQueue::tryPop ( )

pure virtual

Retrieves the first value if available. Returns nullptr otherwise.

Implemented in Arcane::MessagePassing::SharedMemoryBasicAsyncQueue.

---

The documentation for this class was generated from the following files:

• IAsyncQueue.h
• AsyncQueue.cc