virtuoso v0.0.25 Virtuoso.Conversation

GenServer to maintain conversation state

Link to this section Summary

Types

Sender id for facebook messages

Conversation state

Functions

Returns a specification to start this module under a supervisor

Ensure a process is alive before sending data to it

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Helper for determining a conversation registered process name

A message is received. Ensure the process is alive and forward it

A message is sent. Ensure the process is alive and forward it

Terminate a conversation process

Link to this section Types

Link to this type sender_id()
sender_id() :: String.t()

Sender id for facebook messages

Link to this type state()
state() :: %Virtuoso.Conversation.State{
  environment: term(),
  last_recieved_at: term(),
  messages: term(),
  pid: term(),
  sender_id: term()
}

Conversation state

Link to this section Functions

Link to this function child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function ensure_process(sender_id)
ensure_process(sender_id()) :: :ok

Ensure a process is alive before sending data to it

Link to this function init(sender_id)

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Link to this function pid(sender_id)
pid(sender_id()) :: tuple()

Helper for determining a conversation registered process name

Link to this function received_message(entry)
received_message(map()) :: :ok

A message is received. Ensure the process is alive and forward it

Link to this function sent_message(sender_id, response)
sent_message(sender_id(), map()) :: :ok

A message is sent. Ensure the process is alive and forward it

Link to this function terminate(sender_id)
terminate(sender_id()) :: :ok

Terminate a conversation process