the_end

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #macos #nodejs #windows #awesome #vue #awesome-list #pytorch #mcp #openai #open-source

(★ 13)

Elixir Library: provides a graceful shutdown support for your Phoenix, or plain Plug application

the_end 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TheEnd

This library provides a graceful shutdown support for your Phoenix, or plain Plug application.

Original idea is

https://gist.github.com/aaronjensen/33cc2aeb74746cac3bcb40dcefdd9c09

Many of the logic in this library is borrowed from here.
I added a little bit componentization

Now, with this library, you can support graceful shutdown for your application built with

- Plug
- Phoenix 1.3
- 1.2 or more older version of Phoenix

And you also can use only AcceptanceStopper, without waiting pending requests to finish.
This is for WebSocket application.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `the_end` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:the_end, "~> 1.1.1"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/the_end](https://hexdocs.pm/the_end).

## Usage

### Phoenix Endpoint

```elixir
  children = [

{MyApp.Endpoint, []},

# ... other supervisors/workers

# you should set this supervisor at last
    {TheEnd.Of.Phoenix, [timeout: 10_000, endpoint: MyApp.Endpoint]}
  ]
  Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)
```

If your Phoenix version is 1.2 or older, use TheEnd.Of.LegacyPhoenix instead of TheEnd.Of.Phoenix.

### Plug

You need a Plug wrapper supervisor

```elixir
defmodule MyApp.HTTPSupervisor do

use Supervisor

def start_link() do
    Supervisor.start_link(__MODULE__, nil, name: __MODULE__)
  end

def init(_args) do
      [Plug.Adapters.Cowboy.child_spec(:http,
        MyApp.Router, [], [port: 3000])]
    |> Supervisor.init(strategy: :one_for_one)
  end

end
```

```elixir
  children = [

MyApp.HTTPSupervisor,

# ... other supervisors/workers

# you should set this supervisor at last
    {TheEnd.Of.Plug, [timeout: 10_000, endpoint: MyApp.HTTPSupervisor]}
  ]

Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)
```

Or else if you don't need to wait for requests to finish.
(For instance, WebSocket application)

```elixir
  children = [

{MyApp.HTTPSupervisor[]},

# ... other supervisors/workers

# you should set this worker at last
    {TheEnd.AcceptanceStopper,
     [gatherer: TheEnd.ListenerGatherer.Plug, endpoint: MyApp.HTTPSupervisor]}
  ]

Supervisor.start_link(children, strategy: :one_for_one, name: MyApp.Supervisor)
```

You can choose **gatherer** option for your situation

- TheEnd.ListenerGatherer.Plug
- TheEnd.ListenerGatherer.Phoenix
- TheEnd.ListenerGatherer.LegacyPhoenix

the_end

the_end 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

the_end

the_end 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README