Packages

c

io.gatling.javaapi.core

SharedQueueBuilder

final class SharedQueueBuilder extends AnyRef

A factory of actions that exchange values over an in-memory queue, so virtual users can communicate with each other.

The queue is owned by this very instance, so it must be stored in a field that's then used everywhere the queue must be accessed.

The queue is local to this load generator: when running a distributed test with Gatling Enterprise, each load generator has its own queue and they don't exchange values with each other.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SharedQueueBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SharedQueueBuilder(name: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. def peek(key: String): ActionBuilder

    Define an action that copies the oldest value of this queue into the virtual user's Session, leaving it in the queue.

    Define an action that copies the oldest value of this queue into the virtual user's Session, leaving it in the queue. If the queue is empty, the virtual user is marked as failed and moves on instead of waiting, and the Session attribute is left untouched.

    key

    the name of the Session attribute the value is stored into

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  15. def poll(key: String): ActionBuilder

    Define an action that pops the oldest value of this queue into the virtual user's Session.

    Define an action that pops the oldest value of this queue into the virtual user's Session. If the queue is empty, the virtual user is marked as failed and moves on instead of waiting, and the Session attribute is left untouched.

    key

    the name of the Session attribute the value is stored into

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  16. def put(value: Function[Session, AnyRef]): ActionBuilder

    Define an action that stores a value into this queue, then moves on without waiting.

    Define an action that stores a value into this queue, then moves on without waiting.

    value

    the value to be enqueued, expressed as a function

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  17. def put(value: AnyRef): ActionBuilder

    Define an action that stores a value into this queue, then moves on without waiting.

    Define an action that stores a value into this queue, then moves on without waiting.

    value

    the static value to be enqueued

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  18. def put(value: String): ActionBuilder

    Define an action that stores a value into this queue, then moves on without waiting.

    Define an action that stores a value into this queue, then moves on without waiting.

    value

    the value to be enqueued, expressed as a Gatling Expression Language String

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  19. def size(key: String): ActionBuilder

    Define an action that stores the current number of values in this queue into the virtual user's Session.

    Define an action that stores the current number of values in this queue into the virtual user's Session.

    key

    the name of the Session attribute the size is stored into

    returns

    an ActionBuilder

    Annotations
    @NonNull()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def take(key: String): SharedQueueTakeBuilder

    Define an action that pops the oldest value of this queue into the virtual user's Session.

    Define an action that pops the oldest value of this queue into the virtual user's Session. If the queue is empty, the virtual user waits until a value is available, possibly forever unless SharedQueueTakeBuilder#timeout(java.time.Duration) is used.

    key

    the name of the Session attribute the value is stored into

    returns

    a new SharedQueueTakeBuilder

    Annotations
    @NonNull()
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped