shackle

сковывать

Высокопроизводительная сетевая клиентская среда Erlang

Требования

• Эрланг 19.0+

Функции

• Противодавление через отставание (защита OOM)
• Быстрая реализация пула (случайный, round_robin)
• Управляемые тайм-ауты
• Поддержка нескольких протоколов (SSL/TCP/UDP)
• Оптимизированная производительность
• Запросить конвейерную обработку
• Интеллектуальный механизм переподключения (экспоненциальная отсрочка)

Рамочные цели

• Многоразовое использование
• Скорость
• Параллелизм
• Безопасность

Как сделать

Реализация клиента

- behavior ( shackle_client ).
- export ([
    init / 0 ,
    setup / 2 ,
    handle_request / 2 ,
    handle_data / 2 ,
    terminate / 1
]).

- record ( state , {
    buffer =       <<>> :: binary (),
    request_counter = 0 :: non_neg_integer ()
}).

- spec init ( Options :: term ()) ->
    { ok , State :: term ()} |
    { error , Reason :: term ()}.

init ( _Options ) ->
    { ok , # state {}}.

- spec setup ( Socket :: inet : socket (), State :: term ()) ->
    { ok , State :: term ()} |
    { error , Reason :: term (), State :: term ()}.

setup ( Socket , State ) ->
    case gen_tcp : send ( Socket , << " INIT " >>) of
        ok ->
            case gen_tcp : recv ( Socket , 0 ) of
                { ok , << " OK " >>} ->
                    { ok , State };
                { error , Reason } ->
                    { error , Reason , State }
            end ;
        { error , Reason } ->
            { error , Reason , State }
    end .

- spec handle_request ( Request :: term (), State :: term ()) ->
    { ok , RequestId :: external_request_id (), Data :: iodata (), State :: term ()}.

handle_request ( noop ,  State ) ->
    Data = arithmetic_protocol : request ( 0 , noop , 0 , 0 ),

    { ok , undefined , Data , State };
handle_request ({ Operation , A , B }, # state {
        request_counter = RequestCounter
    } = State ) ->

    RequestId = request_id ( RequestCounter ),
    Data = request ( RequestId , Operation , A , B ),

    { ok , RequestId , Data , State # state {
        request_counter = RequestCounter + 1
    }}.

- spec handle_data ( Data :: binary (), State :: term ()) ->
    { ok , [{ RequestId :: external_request_id (), Reply :: term ()}], State :: term ()}.

handle_data ( Data , # state {
        buffer = Buffer
    } = State ) ->

    Data2 = << Buffer / binary , Data / binary >>,
    { Replies , Buffer2 } = parse_replies ( Data2 , []),

    { ok , Replies , State # state {
        buffer = Buffer2
    }}.

- spec terminate ( State :: term ()) -> ok .

terminate ( _State ) -> ok .

Запуск клиентского пула

 shackle_pool : start ( shackle_pool : name (), client (), client_options (), pool_options ())

client_options:

Имя	Тип	По умолчанию	Описание
адрес	инет:ip_адрес() | инет: имя хоста ()	"127.0.0.1"	адрес сервера (ранее ip)
порт	инет:port_number()	неопределенный	порт сервера
протокол	shackle_tcp | shackle_udp | shackle_ssl	shackle_tcp	протокол сервера
повторно подключиться	логическое значение()	истинный	восстановить закрытые соединения
reconnect_time_max	pos_integer() | бесконечность	120000	максимальное время переподключения в миллисекундах
reconnect_time_min	pos_integer()	1000	минимальное время переподключения в миллисекундах
параметры сокета	[gen_tcp:connect_option() | gen_udp:опция()]	[]	параметры, передаваемые в сокет

параметры пула:

Имя	Тип	По умолчанию	Описание
backlog_size	pos_integer() | бесконечность	1024	максимальное количество одновременных запросов на одно соединение
max_retries	non_neg_integer()	3	максимальное количество попыток найти активный сервер
размер_пула	pos_integer()	16	количество соединений
пул_стратегия	случайный | round_robin	случайный	стратегия выбора соединения

Звонок/кастинг клиента

 1 > shackle : call ( pool_name , { get , << " test " >>}).
{ ok , << " bar " >>}

2 > { ok , ReqId } = shackle : cast ( pool_name , { get , << " foo " >>}, 500 ).
{ ok , { anchor , anchor_client , # Ref < 0.0 . 0.2407 > }}

3 > shackle : receive_response ( ReqId ).
{ ok , << " bar " >>}

Телеметрия

Shackle интегрируется с независимой от серверной библиотеки телеметрии. См. список событий телеметрии, которые может генерировать кандал, shackle_telemetry .

Тесты

make dialyzer
make eunit
make xref

Тестирование производительности

Для запуска целей тестирования производительности необходимо сначала запустить сервер:

 ./bin/server.sh

Затем вы можете запустить bench или profile цель:

make bench
make profile

Клиенты

Имя	Описание
якорь	Мемкеш-клиент
aspike-узел	Клиент Aerospike
буй	HTTP 1.1-клиент
вспышка	Кафка Продюсер
пристань для яхт	Кассандра CQL-клиент
статистика	Клиент StatsD

Лицензия

 The MIT License (MIT)

Copyright (c) 2015-2023 Louis-Philippe Gauthier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.