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 ())

خيارات_العميل:

اسم	يكتب	تقصير	وصف
عنوان	إنت:ip_address() | إنت: اسم المضيف ()	"127.0.0.1"	عنوان الخادم (IP سابقًا)
ميناء	إنت:port_number()	غير محدد	منفذ الخادم
بروتوكول	shackle_tcp | تكبل_udp | shackle_ssl	shackle_tcp	بروتوكول الخادم
أعد الاتصال	منطقية ()	حقيقي	إعادة توصيل الاتصالات المغلقة
reconnect_time_max	pos_integer() | إنفينيتي	120000	الحد الأقصى لوقت إعادة الاتصال بالمللي ثانية
reconnect_time_min	pos_integer()	1000	الحد الأدنى لوقت إعادة الاتصال بالمللي ثانية
المقبس_خيارات	[gen_tcp:connect_option() | gen_udp:option()]	[]	الخيارات التي تم تمريرها إلى المقبس

خيارات_التجمع:

اسم	يكتب	تقصير	وصف
backlog_size	pos_integer() | إنفينيتي	1024	الحد الأقصى لعدد الطلبات المتزامنة لكل اتصال
max_retries	غير_neg_integer()	3	الحد الأقصى لعدد المحاولات للعثور على خادم نشط
pool_size	pos_integer()	16	عدد الاتصالات
Pool_Strategy	عشوائي | 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_telemetry للحصول على قائمة بأحداث القياس عن بعد التي يمكن أن يصدرها القيد.

الاختبارات

make dialyzer
make eunit
make xref

اختبار الأداء

لتشغيل أهداف اختبار الأداء، يجب عليك أولاً تشغيل الخادم:

 ./bin/server.sh

بعد ذلك يمكنك تشغيل bench أو هدف profile :

make bench
make profile

العملاء

اسم	وصف
مِرسَاة	عميل Memcached
aspik-عقدة	عميل إيروسبايك
العوامة	عميل HTTP 1.1
مضيئة	منتج كافكا
مارينا	عميل كاساندرا CQL
statsderl	عميل 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.