org.bytedeco.depthai

Class DataInputQueue

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.DataInputQueue

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class DataInputQueue
extends Pointer

Access to send messages through XLink stream

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
DataInputQueue(Pointer p) Pointer cast constructor.
DataInputQueue(XLinkConnection conn, BytePointer streamName)
DataInputQueue(XLinkConnection conn, BytePointer streamName, int maxSize, boolean blocking)
DataInputQueue(XLinkConnection conn, String streamName)
DataInputQueue(XLinkConnection conn, String streamName, int maxSize, boolean blocking)

Method Summary

Modifier and Type	Method and Description
void	_close() Closes the queue and the underlying thread
boolean	getBlocking() Gets current queue behavior when full (maxSize)
long	getMaxDataSize() Gets maximum queue size.
int	getMaxSize() Gets queue maximum size
BytePointer	getName() Gets queues name
boolean	isClosed() Check whether queue is closed
void	send(ADatatype msg) Adds a message to the queue, which will be picked up and sent to the device.
boolean	send(ADatatype msg, Pointer timeout) Adds message to the queue, which will be picked up and sent to the device.
void	send(RawBuffer rawMsg) Adds a raw message to the queue, which will be picked up and sent to the device.
boolean	send(RawBuffer rawMsg, Pointer timeout) Adds message to the queue, which will be picked up and sent to the device.
void	sendSharedPtr(ADatatype msg) Adds a message to the queue, which will be picked up and sent to the device.
boolean	sendSharedPtr(ADatatype msg, Pointer timeout) Adds message to the queue, which will be picked up and sent to the device.
void	setBlocking(boolean blocking) Sets queue behavior when full (maxSize)
void	setMaxDataSize(long maxSize) Sets maximum message size.
void	setMaxSize(int maxSize) Sets queue maximum size

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataInputQueue

public DataInputQueue(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DataInputQueue

public DataInputQueue(@SharedPtr
                      XLinkConnection conn,
                      @StdString
                      BytePointer streamName,
                      @Cast(value="unsigned int")
                      int maxSize,
                      @Cast(value="bool")
                      boolean blocking)

DataInputQueue

public DataInputQueue(@SharedPtr
                      XLinkConnection conn,
                      @StdString
                      BytePointer streamName)

DataInputQueue

public DataInputQueue(@SharedPtr
                      XLinkConnection conn,
                      @StdString
                      String streamName,
                      @Cast(value="unsigned int")
                      int maxSize,
                      @Cast(value="bool")
                      boolean blocking)

DataInputQueue

public DataInputQueue(@SharedPtr
                      XLinkConnection conn,
                      @StdString
                      String streamName)

Method Detail

isClosed

@Cast(value="bool")
public boolean isClosed()

Check whether queue is closed

_close

@Name(value="close")
public void _close()

Closes the queue and the underlying thread

setMaxDataSize

public void setMaxDataSize(@Cast(value="std::size_t")
                           long maxSize)

Sets maximum message size. If message is larger than specified, then an exception is issued.

Parameters:

maxSize - Maximum message size to add to queue

getMaxDataSize

@Cast(value="std::size_t")
public long getMaxDataSize()

Gets maximum queue size.

Returns:

Maximum message size

setBlocking

public void setBlocking(@Cast(value="bool")
                        boolean blocking)

Sets queue behavior when full (maxSize)

Parameters:

blocking - Specifies if block or overwrite the oldest message in the queue

getBlocking

@Cast(value="bool")
public boolean getBlocking()

Gets current queue behavior when full (maxSize)

Returns:

True if blocking, false otherwise

setMaxSize

public void setMaxSize(@Cast(value="unsigned int")
                       int maxSize)

Sets queue maximum size

Parameters:

maxSize - Specifies maximum number of messages in the queue

getMaxSize

@Cast(value="unsigned int")
public int getMaxSize()

Gets queue maximum size

Returns:

Maximum queue size

getName

@StdString
public BytePointer getName()

Gets queues name

Returns:

Queue name

send

public void send(@SharedPtr
                 RawBuffer rawMsg)

Adds a raw message to the queue, which will be picked up and sent to the device. Can either block if 'blocking' behavior is true or overwrite oldest

Parameters:

rawMsg - Message to add to the queue

sendSharedPtr

@Name(value="send")
public void sendSharedPtr(@Const @SharedPtr @ByRef
                                              ADatatype msg)

Adds a message to the queue, which will be picked up and sent to the device. Can either block if 'blocking' behavior is true or overwrite oldest

Parameters:

msg - Message to add to the queue

send

public void send(@Const @ByRef
                 ADatatype msg)

Adds a message to the queue, which will be picked up and sent to the device. Can either block if 'blocking' behavior is true or overwrite oldest

Parameters:

msg - Message to add to the queue

send

@Cast(value="bool")
public boolean send(@SharedPtr
                                        RawBuffer rawMsg,
                                        @ByVal @Cast(value="std::chrono::milliseconds*")
                                        Pointer timeout)

Adds message to the queue, which will be picked up and sent to the device. Can either block until timeout if 'blocking' behavior is true or overwrite oldest

Parameters:

rawMsg - Message to add to the queue

timeout - Maximum duration to block in milliseconds

sendSharedPtr

@Cast(value="bool")
 @Name(value="send")
public boolean sendSharedPtr(@Const @SharedPtr @ByRef
                                                                      ADatatype msg,
                                                                      @ByVal @Cast(value="std::chrono::milliseconds*")
                                                                      Pointer timeout)

Adds message to the queue, which will be picked up and sent to the device. Can either block until timeout if 'blocking' behavior is true or overwrite oldest

Parameters:

msg - Message to add to the queue

timeout - Maximum duration to block in milliseconds

send

@Cast(value="bool")
public boolean send(@Const @ByRef
                                        ADatatype msg,
                                        @ByVal @Cast(value="std::chrono::milliseconds*")
                                        Pointer timeout)

Adds message to the queue, which will be picked up and sent to the device. Can either block until timeout if 'blocking' behavior is true or overwrite oldest

Parameters:

msg - Message to add to the queue

timeout - Maximum duration to block in milliseconds