https://github.com/elixir-ecto/connection

Connection behaviour for connection processes
https://github.com/elixir-ecto/connection

Last synced: about 2 months ago
JSON representation

Connection behaviour for connection processes

• Host: GitHub
• URL: https://github.com/elixir-ecto/connection
• Owner: elixir-ecto
• License: apache-2.0
• Created: 2015-05-10T23:42:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-26T05:35:48.000Z (about 2 months ago)
• Last Synced: 2024-04-29T05:07:12.470Z (about 2 months ago)
• Language: Elixir
• Homepage: https://hexdocs.pm/connection/Connection.html
• Size: 77.1 KB
• Stars: 263
• Watchers: 13
• Forks: 22
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-elixir - connection - Connection behaviour for connection processes. The API is superset of the GenServer API. (Behaviours and Interfaces)

README

        
# Connection

*Note:* with the inclusion of [`gen_statem`](https://www.erlang.org/doc/man/gen_statem.html)

in Erlang/OTP, this project is no longer necessary. See the following pull request as examples

of replacing `Connection` by `gen_statem` in existing projects:

  * https://github.com/elixir-ecto/postgrex/pull/643

  * https://github.com/elixir-ecto/postgrex/pull/644

  * https://github.com/elixir-ecto/db_connection/pull/275

We may release new versions if necessary to keep compatibility with Erlang/OTP and

Elixir but otherwise this package is no longer recommended for new projects.

---

`Connection` behaviour for connection processes. The API is superset of the

GenServer API. There are 2 additional callbacks `connect/2` and `disconnect/2`:

```elixir

  @callback init(any) ::

    {:ok, any} | {:ok, any, timeout | :hibernate} |

    {:connect, any, any} |

    {:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |

    :ignore | {:stop, any}

  @callback connect(any, any) ::

    {:ok, any} | {:ok, any, timeout | :hibernate} |

    {:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |

    {:stop, any, any}

  @callback disconnect(any, any) ::

    {:connect, any, any} |

    {:backoff, timeout, any} | {:backoff, timeout, any, timeout | :hibernate} |

    {:noconnect, any} | {:noconnect, any, timeout | :hibernate}

    {:stop, any, any}

  @callback handle_call(any, {pid, any}, any) ::

    {:reply, any, any} | {:reply, any, any, timeout | :hibernate} |

    {:noreply, any} | {:noreply, any, timeout | :hibernate} |

    {:disconnect | :connect, any, any} |

    {:disconnect | :connect, any, any, any} |

    {:stop, any, any} | {:stop, any, any, any}

  @callback handle_cast(any, any) ::

    {:noreply, any} | {:noreply, any, timeout | :hibernate} |

    {:disconnect | :connect, any, any} |

    {:stop, any, any}

  @callback handle_info(any, any) ::

    {:noreply, any} | {:noreply, any, timeout | :hibernate} |

    {:disconnect | :connect, any, any} |

    {:stop, any, any}

  @callback code_change(any, any, any) :: {:ok, any}

  @callback terminate(any, any) :: any

```

There is an example of a simple TCP connection process in

`examples/tcp_connection/`.

## License

Copyright 2015 James Fish

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.