shackle

belenggu

Kerangka Klien Jaringan Erlang Berkinerja Tinggi

Persyaratan

• Erlang 19.0+

Fitur

• Tekanan balik melalui backlog (perlindungan OOM)
• Implementasi kumpulan cepat (acak, round_robin)
• Batas waktu terkelola
• Dukungan multi-protokol (SSL / TCP / UDP)
• Dioptimalkan kinerja
• Minta perpipaan
• Mekanisme penyambungan kembali yang cerdas (backoff eksponensial)

Tujuan kerangka

• Dapat digunakan kembali
• Kecepatan
• Konkurensi
• Keamanan

Bagaimana caranya

Menerapkan klien

- 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 .

Memulai kumpulan klien

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

opsi_klien:

Nama	Jenis	Bawaan	Keterangan
alamat	inet:alamat_ip() | inet:nama host()	"127.0.0.1"	alamat server (sebelumnya ip)
pelabuhan	inet: nomor_port()	belum diartikan	pelabuhan server
protokol	belenggu_tcp | belenggu_udp | belenggu_ssl	belenggu_tcp	protokol server
menyambung kembali	boolean()	BENAR	sambungkan kembali koneksi tertutup
sambungkan kembali_waktu_maks	pos_integer() | ketakterbatasan	120000	waktu penyambungan kembali maksimum dalam milidetik
sambungkan kembali_time_min	pos_integer()	1000	waktu penyambungan kembali minimum dalam milidetik
soket_options	[gen_tcp:connect_option() | gen_udp:pilihan()]	[]	opsi diteruskan ke soket

pilihan_kumpulan:

Nama	Jenis	Bawaan	Keterangan
backlog_size	pos_integer() | ketakterbatasan	1024	jumlah maksimum permintaan bersamaan per koneksi
max_retries	bukan_neg_integer()	3	jumlah maksimum percobaan untuk menemukan server yang aktif
ukuran_kolam	pos_integer()	16	jumlah koneksi
pool_strategy	acak | round_robin	acak	strategi pemilihan koneksi

Memanggil / Mentransmisikan klien

 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 " >>}

Telemetri

Shackle terintegrasi dengan perpustakaan telemetri backend-agnostik. Lihat shackle_telemetry untuk daftar peristiwa telemetri yang dapat dipancarkan oleh belenggu.

Tes

make dialyzer
make eunit
make xref

Pengujian kinerja

Untuk menjalankan target pengujian kinerja, Anda harus memulai server terlebih dahulu:

 ./bin/server.sh

Kemudian Anda dapat menjalankan target bench atau profile :

make bench
make profile

Klien

Nama	Keterangan
jangkar	Klien Memcache
simpul-aspike	Klien Aerospike
pelampung	Klien HTTP 1.1
suar	Produser Kafka
marina	Klien Cassandra CQL
statsderl	Klien StatsD

Lisensi

 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.