trait Consumer extends Actor with CamelSupport
Mixed in by Actor implementations that consume message from Camel endpoints.
- Source
- Consumer.scala
- Alphabetic
- By Inheritance
- Consumer
- CamelSupport
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Abstract Value Members
-
abstract
def
endpointUri: String
Must return the Camel endpoint URI that the consumer wants to consume messages from.
-
abstract
def
receive: actor.Actor.Receive
This defines the initial actor behavior, it must return a partial function with the actor logic.
This defines the initial actor behavior, it must return a partial function with the actor logic.
- Definition Classes
- Actor
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Consumer, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
activationTimeout: FiniteDuration
How long the actor should wait for activation before it fails.
-
def
aroundPostRestart(reason: Throwable): Unit
Can be overridden to intercept calls to
postRestart
. -
def
aroundPostStop(): Unit
Can be overridden to intercept calls to
postStop
. -
def
aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
Can be overridden to intercept calls to
preRestart
. -
def
aroundPreStart(): Unit
Can be overridden to intercept calls to
preStart
. -
def
aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
INTERNAL API.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
autoAck: Boolean
Determines whether one-way communications between an endpoint and this consumer actor should be auto-acknowledged or application-acknowledged.
Determines whether one-way communications between an endpoint and this consumer actor should be auto-acknowledged or application-acknowledged. This flag has only effect when exchange is in-only.
-
val
camel: Camel
INTERNAL API Returns a akka.camel.Camel trait which provides access to the CamelExtension.
INTERNAL API Returns a akka.camel.Camel trait which provides access to the CamelExtension.
- Attributes
- protected
- Definition Classes
- CamelSupport
-
implicit
def
camelContext: DefaultCamelContext
Returns the CamelContext.
Returns the CamelContext. The camelContext is defined implicit for simplifying the use of CamelMessage from the Scala API.
- Attributes
- protected
- Definition Classes
- CamelSupport
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
implicit
val
context: ActorContext
Stores the context for this actor, including self, and sender.
Stores the context for this actor, including self, and sender. It is implicit to support operations such as
forward
.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
akka.actor.ActorContext is the Scala API.
getContext
returns a akka.actor.UntypedActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- def ensuring(cond: (Consumer) ⇒ Boolean, msg: ⇒ Any): Consumer
- def ensuring(cond: (Consumer) ⇒ Boolean): Consumer
- def ensuring(cond: Boolean, msg: ⇒ Any): Consumer
- def ensuring(cond: Boolean): Consumer
-
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] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getRouteDefinitionHandler: Mapper[RouteDefinition, ProcessorDefinition[_]]
Java API: Returns the akka.dispatch.Mapper function that will be used as a route definition handler for creating custom route to this consumer.
Java API: Returns the akka.dispatch.Mapper function that will be used as a route definition handler for creating custom route to this consumer. By default it returns an identity function, override this method to return a custom route definition handler. The akka.dispatch.Mapper is not allowed to close over 'this', meaning it is not allowed to refer to the actor instance itself, since that can easily cause concurrent shared state issues.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
onRouteDefinition: (RouteDefinition) ⇒ ProcessorDefinition[_]
Returns the route definition handler for creating a custom route to this consumer.
Returns the route definition handler for creating a custom route to this consumer. By default it returns an identity function, override this method to return a custom route definition handler. The returned function is not allowed to close over 'this', meaning it is not allowed to refer to the actor instance itself, since that can easily cause concurrent shared state issues.
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart()
.User overridable callback: By default it calls
preStart()
.- reason
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preRestart(reason: Throwable, message: Option[Any]): Unit
User overridable callback: By default it disposes of all children and then calls
postStop()
.User overridable callback: By default it disposes of all children and then calls
postStop()
.- reason
the Throwable that caused the restart to happen
- message
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- Definition Classes
- Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preStart(): Unit
Registers the consumer endpoint.
-
def
replyTimeout: FiniteDuration
When endpoint is out-capable (can produce responses) replyTimeout is the maximum time the endpoint can take to send the response before the message exchange fails.
When endpoint is out-capable (can produce responses) replyTimeout is the maximum time the endpoint can take to send the response before the message exchange fails. It defaults to 1 minute. This setting is used for out-capable, in-only, manually acknowledged communication.
-
implicit final
val
self: ActorRef
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
The reference sender Actor of the last received message.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else
deadLetters
in akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
-
def
supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- Actor
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
unhandled(message: Any): Unit
User overridable callback.
User overridable callback.
Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream
- Definition Classes
- Actor
-
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( ... )
- def →[B](y: B): (Consumer, B)