akka.http

RootEndpoint

class RootEndpoint extends Actor with Endpoint

Linear Supertypes
Endpoint, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. RootEndpoint
  2. Endpoint
  3. Actor
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RootEndpoint ()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Type alias because traits cannot have companion objects.

    Type alias because traits cannot have companion objects.

    Definition Classes
    Actor

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

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

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. val Root : java.lang.String("/")

    Attributes
    final
  7. def _attach (hook: Hook, provider: Provider): Unit

    Attributes
    protected
    Definition Classes
    Endpoint
  8. var _attachments : List[(Hook, Provider)]

    The list of connected endpoints to which this one should/could forward the request.

    The list of connected endpoints to which this one should/could forward the request. If the hook func returns true, the message will be sent to the actor returned from provider.

    Attributes
    protected
    Definition Classes
    Endpoint
  9. def _na (uri: String, req: RequestMethod): Boolean

    no endpoint available - completes the request with a 404

    no endpoint available - completes the request with a 404

    Attributes
    protected
    Definition Classes
    Endpoint
  10. def actor : ActorRef

    A convenience method to get the actor ref

    A convenience method to get the actor ref

    Definition Classes
    Endpoint
  11. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  12. def become (behavior: Receive, discardOld: Boolean = true): Unit

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler.

    Changes the Actor's behavior to become the new 'Receive' (PartialFunction[Any, Unit]) handler. Puts the behavior on top of the hotswap stack. If "discardOld" is true, an unbecome will be issued prior to pushing the new behavior to the stack

    Definition Classes
    Actor
  13. def clone (): AnyRef

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

    Attributes
    final
    Definition Classes
    AnyRef
  15. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  17. def freshInstance (): Option[Actor]

    User overridable callback.

    User overridable callback.

    Is called on the crashed Actor to give it the option of producing the Actor's reincarnation. If it returns None, which is the default, the initially provided actor factory is used.

    Warning: Propagating state from a crashed actor carries the risk of proliferating the cause of the error. Consider let-it-crash first.

    Definition Classes
    Actor
    Annotations
    @experimental( since = "1.2" )
  18. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  19. def handleHttpRequest : Receive

    Message handling common to all endpoints, must be chained

    Message handling common to all endpoints, must be chained

    Attributes
    protected
    Definition Classes
    Endpoint
  20. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  21. def isDefinedAt (message: Any): Boolean

    Is the actor able to handle the message passed in as arguments?

    Is the actor able to handle the message passed in as arguments?

    Definition Classes
    Actor
  22. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  23. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  24. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  25. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  26. def optionSelf : Option[ActorRef]

    Option[ActorRef] representation of the 'self' ActorRef reference.

    Option[ActorRef] representation of the 'self' ActorRef reference.

    Mainly for internal use, functions as the implicit sender references when invoking one of the message send functions ('!', '!!' and '!!!').

    Definition Classes
    Actor
  27. def postRestart (reason: Throwable): Unit

    User overridable callback.

    User overridable callback.

    Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
  28. def postStop (): Unit

    User overridable callback.

    User overridable callback.

    Is called when 'actor.stop()' is invoked.

    Definition Classes
    Actor
  29. def preRestart (reason: Throwable, message: Option[Any]): Unit

    User overridable callback.

    User overridable callback.

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. Override either the variant with or without the currentMessage argument.

    Definition Classes
    Actor
  30. def preStart (): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started by invoking 'actor.start()'.

    Definition Classes
    RootEndpointActor
  31. def receive : PartialFunction[Any, Unit]

    Note that root is a little different, other endpoints should chain their own recv first

    Note that root is a little different, other endpoints should chain their own recv first

    Definition Classes
    RootEndpointActor
  32. def recv : Receive

  33. implicit val self : ScalaActorRef

    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
    
    Here you also find most of the Actor API.

    For example fields like:

    self.dispatcher = ...
    self.trapExit = ...
    self.faultHandler = ...
    self.lifeCycle = ...
    self.sender
    

    Here you also find methods like:

    self.reply(..)
    self.link(..)
    self.unlink(..)
    self.start(..)
    self.stop(..)
    

    Attributes
    implicit
    Definition Classes
    Actor
  34. val someSelf : Some[ActorRef]

    Some[ActorRef] representation of the 'self' ActorRef reference.

    Some[ActorRef] representation of the 'self' ActorRef reference.

    Mainly for internal use, functions as the implicit sender references when invoking the 'forward' function.

    Definition Classes
    Actor
  35. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  36. def toString (): String

    Definition Classes
    AnyRef → Any
  37. def unbecome (): Unit

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Reverts the Actor behavior to the previous one in the hotswap stack.

    Definition Classes
    Actor
  38. def unhandled (msg: 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 throws an UnhandledMessageException

    Definition Classes
    Actor
  39. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def preRestart (reason: Throwable): Unit

    User overridable callback.

    User overridable callback.

    Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated. Override either the variant with or without the currentMessage argument.

    This method is deprecated: use the variant which receives the current message instead. This method will be removed in version 2.0.

    Definition Classes
    Actor
    Annotations
    @deprecated
    Deprecated

    use two-argument version, this one will be removed in 2.0

Inherited from Endpoint

Inherited from Actor

Inherited from AnyRef

Inherited from Any