کلاس WebSocket

این متد ها از ورژن jsscript:0.1.72 در دسترس است.

در این بخش نحوه استفاده از وب‌سوکت‌ها در اپسان توضیح داده می‌شود. وب‌سوکت‌ها به شما امکان می‌دهند ارتباطی دوطرفه و بلادرنگ بین کلاینت و سرور برقرار کنید. ساختار وب‌سوکت در اپسان بر پایه جاوااسکریپت استاندارد است و قابلیت‌هایی مشابه دیگر کتابخانه‌های وب‌سوکت را فراهم می‌کند.


ایجاد اتصال وب‌سوکت

برای ایجاد یک اتصال جدید، از سازنده WebSocket استفاده کنید:

const ws = new WebSocket('ws://example.com/socket', ['protocol1', 'protocol2']);
ورودی‌ها:
  • url (رشته): آدرس URL سرور وب‌سوکت.
  • protocols (اختیاری): یک رشته یا آرایه‌ای از پروتکل‌های موردنظر.

خواص اصلی:

  • url: آدرس وب‌سوکت.
  • protocols: پروتکل‌های انتخاب شده.
  • readyState: وضعیت اتصال (اعداد 0 تا 3 که به ترتیب نشان‌دهنده CONNECTING، OPEN، CLOSING و CLOSED هستند).

متدها:

  1. send(message):

    • پیامی را به سرور ارسال می‌کند.
    • ورودی: یک رشته.

    مثال:

    ws.send('Hello Server!');
    
  2. close():

    • اتصال وب‌سوکت را می‌بندد.

    مثال:

    ws.close();
    

مدیریت رویدادها با addEventListener

برای مدیریت رویدادها در وب‌سوکت، از متد addEventListener استفاده می‌کنید. این متد امکان اضافه کردن لیسنرها برای رویدادهای مختلف مانند message، open، close و error را فراهم می‌کند.

 

رویدادها:
  1. open: زمانی که اتصال وب‌سوکت باز می‌شود.

    ws.addEventListener('open', function (event) {
        console.log('Connection opened');
    });
    
  2. message: برای دریافت پیام‌ها از سرور.

    ws.addEventListener('message', function (event) {
        console.log('Message received:', event.data);
    });
    
  3. close: زمانی که اتصال بسته می‌شود.

    ws.addEventListener('close', function (event) {
        console.log('Connection closed:', event.code, event.reason);
    });
    
  4. error: زمانی که خطایی رخ دهد.

    ws.addEventListener('error', function (event) {
        console.error('WebSocket error:', event.message);
    });

 

برای اطلاعات بیشتر مستندات websocket وب را مطالعه نمایید