TypedHeader

TypedHeader describes a RabbitMQ Message Header or Queue / Exchange / Binding argument; its type is known, and implicit proof is required to prove that the type can be safely converted to a supported RabbitMQ type.

If you use custom headers, using TypedHeader is preferred over Header. For example, if you use the header x-retry, and this header contains an integer, using TypedHeader to extract and set the header will enable the type system enforce that fact:

val RetryHeader = TypedHeader[Int]("x-retry")

Subscription {
  channel() {
    consume(queue("name")) {
      property(RetryHeader) { retries: Int =>
        // ...
        ack
      }
    }
  }
}

rabbitControl ! QueueMessage("My body", "name", Seq(RetryHeader(5)))

Linear Supertypes

MessageProperty, AnyRef, Any

Instance Constructors

new TypedHeader(name: String, value: T)(implicit converter: ToHeaderValue[T, HeaderValue])

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def insert(builder: Builder, headers: HeaderMap): Unit

Definition Classes
TypedHeader → MessageProperty
def insert(headers: HeaderMap): Unit
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def untyped: Header
val value: T
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object TypedHeader | package properties

class TypedHeader[T] extends MessageProperty

Instance Constructors

new TypedHeader(name: String, value: T)(implicit converter: ToHeaderValue[T, HeaderValue])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def insert(builder: Builder, headers: HeaderMap): Unit

def insert(headers: HeaderMap): Unit

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def untyped: Header

val value: T

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from MessageProperty

Inherited from AnyRef

Inherited from Any

Ungrouped