Packages

illithid

0.1.0
0.1.0

Programatically spawn and manage server infrastructure

HexDocs

Current section

Files

Jump to
Readme
1 Version
3 Dependencies
Dependants
Files
Activity
illithid lib server_manager host_api_behaviour.ex
Raw

lib/server_manager/host_api_behaviour.ex 

defmodule Illithid.ServerManager.HostAPIBehaviour do

  @moduledoc """

  The contract for host apis.

  """



  alias Illithid.Models.{Server, ServerCreationContext}



  # TODO(ian): See if we can tighten these return values a little more.

  @callback get_server(String.t()) :: {:ok, Server.t()} | {:error, String.t()}

  @callback list_servers() :: {:ok, [Server.t()]} | {:error, String.t()}

  @callback list_images(bool) :: {:ok, map()} | {:error, atom()}

  @callback create_server(ServerCreationContext.t()) :: {:ok, Server.t()} | {:error, String.t()}

  @callback destroy_server(String.t() | Server.t()) :: {:ok, Server.t()} | {:error, String.t()}

  @callback server_alive?(Server.t()) :: boolean()

end