Module swim.api
Package swim.api.agent

Interface Agent

All Known Implementing Classes:
AbstractAgent, GuestAgent, JsAgent
public interface Agent

  • Method Summary

    Modifier and Type
    Method
    Description
    AgentContext
    agentContext()
    Returns the AgentContext used to manage this Agent.
    void
    didClose()
    Lifecycle callback invoked immediately after this Agent closes.
    void
    didFail(Throwable error)
    Lifecycle callback invoked immediately after this Agent throws error.
    void
    didLoad()
    Lifecycle callback invoked immediately after this Agent loads, i.e.
    void
    didOpen()
    Lifecycle callback invoked immediately after this Agent opens, i.e.
    void
    didStart()
    Lifecycle callback invoked immediately after this Agent starts.
    void
    didStop()
    Lifecycle callback invoked immediately after this Agent stops, i.e.
    void
    didUnload()
    Lifecycle callback invoked immediately after this Agent unloads, i.e.
    void
    willClose()
    Lifecycle callback invoked immediately before this Agent closes.
    void
    willLoad()
    Lifecycle callback invoked immediately before this Agent loads.
    void
    willOpen()
    Lifecycle callback invoked immediately before this Agent opens.
    void
    willStart()
    Lifecycle callback invoked immediately before this Agent starts.
    void
    willStop()
    Lifecycle callback invoked immediately before this Agent stops.
    void
    willUnload()
    Lifecycle callback invoked immediately before this Agent unloads.

  • Method Details

    • agentContext

      AgentContext agentContext()
      Returns the AgentContext used to manage this Agent.

    • willOpen

      void willOpen()
      Lifecycle callback invoked immediately before this Agent opens.

      //@see swim.system.TierBinding#open

    • didOpen

      void didOpen()
      Lifecycle callback invoked immediately after this Agent opens, i.e. before it loads.

      //@see swim.system.TierBinding#open //@see swim.system.TierBinding#load

    • willLoad

      void willLoad()
      Lifecycle callback invoked immediately before this Agent loads.

      //@see swim.system.TierBinding#load

    • didLoad

      void didLoad()
      Lifecycle callback invoked immediately after this Agent loads, i.e. before it starts.

      //@see swim.system.TierBinding#load //@see swim.system.TierBinding#start

    • willStart

      void willStart()
      Lifecycle callback invoked immediately before this Agent starts.

      //@see swim.system.TierBinding#start

    • didStart

      void didStart()
      Lifecycle callback invoked immediately after this Agent starts.

      //@see swim.system.TierBinding#start

    • willStop

      void willStop()
      Lifecycle callback invoked immediately before this Agent stops.

      //@see swim.system.TierBinding#stop

    • didStop

      void didStop()
      Lifecycle callback invoked immediately after this Agent stops, i.e. before it unloads.

      //@see swim.system.TierBinding#stop //@see swim.system.TierBinding#unload

    • willUnload

      void willUnload()
      Lifecycle callback invoked immediately before this Agent unloads.

      //@see swim.system.TierBinding#unload

    • didUnload

      void didUnload()
      Lifecycle callback invoked immediately after this Agent unloads, i.e. before it closes.

      //@see swim.system.TierBinding.unload //@see swim.system.TierBinding.close

    • willClose

      void willClose()
      Lifecycle callback invoked immediately before this Agent closes.

      //@see swim.system.TierBinding.close

    • didClose

      void didClose()
      Lifecycle callback invoked immediately after this Agent closes.

      //@see swim.system.TierBinding.close

    • didFail

      void didFail(Throwable error)
      Lifecycle callback invoked immediately after this Agent throws error.