SocketIO DAT

پرش به ناوبری | پرش به جستجو

خلاصه (Summary)

SocketIO DAT به یک سرور Socket.IO در URL مشخص شده متصل می‌شود.

این DAT دارای ۴ ورودی است که به ترتیب زیر هستند (مثال):

  1. هدرهای اضافی به صورت جدول با دو ستون، به شکل جفت‌های name/value. معادل گزینه extraHeaders در Socket.IO.

  2. رویدادهای سرور برای گوش دادن به صورت جدول با یک ستون شامل نام رویدادها. وقتی سرور هر یک از این رویدادها را ارسال کند، onReceiveEvent callback فعال می‌شود.

  3. پارامترهای Query اضافی به صورت جدول با دو ستون، جفت name/value. معادل گزینه query در Socket.IO.

  4. پارامترهای احراز هویت (Authentication) به صورت جدول با دو ستون، جفت name/value. معمولاً برای احراز هویت socket.io نیاز به توکن است. معادل گزینه auth در Socket.IO.

همچنین SocketIO DAT می‌تواند رویدادها را به سرور ارسال کند. این کار با استفاده از متد emit در پایتون انجام می‌شود. Acknowledgement callbacks پشتیبانی نمی‌شوند.

این DAT با Socket.IO C++ Client API v3.1.0 ساخته شده و با سرورهای Socket.IO v3 یا v4 سازگار است.

SocketIO DAT پیام‌های وضعیت Socket.IO را در کنسول متنی TouchDesigner چاپ می‌کند. برای فعال کردن کنسول متنی، متغیر محیطی زیر را تنظیم کنید:

TOUCH_TEXT_CONSOLE=1

کنسول متنی در بار بعدی اجرای TouchDesigner باز خواهد شد.

برای اطلاعات بیشتر: WebSocket DAT, Web Client DAT


محتوا (Contents)

  1. Summary

  2. Parameters – Connect Page

  3. Parameters – Received Messages Page

  4. Parameters – Common Page

  5. Operator Inputs

  6. Info CHOP Channels
     6.1 Common DAT Info Channels
     6.2 Common Operator Info Channels


پارامترها – Connect Page

  • Active (active)
    وقتی فعال است، SocketIO DAT به طور فعال در حال گوش دادن به رویدادهای سرور است و می‌تواند رویدادها را نیز ارسال کند.

  • Reset (reset)
    اتصال را قطع کرده و دوباره وصل می‌کند.

  • URL (url)
    URL سرور Socket.IO.

  • Verify Certificate (TLS) (verifycert)
    فعال کردن بررسی گواهی TLS (Transport Layer Security).

  • Reconnect Delay (delay)
    تأخیر بین تلاش‌های اتصال مجدد بر حسب میلی‌ثانیه.


پارامترها – Received Messages Page

  • Callbacks DAT (callbacks)
    Callback DAT برای هر پیام دریافتی اجرا می‌شود.

  • Execute from (executeloc)
    محل اجرای اسکریپت را تعیین می‌کند.

  • From Operator (fromop)
    اپراتوری که تغییر وضعیت آن باعث اجرای اسکریپت می‌شود وقتی Execute from روی Specified Operator تنظیم شده باشد. مسیر اجرای اسکریپت نیز همان اپراتور خواهد بود.

  • Clamp Output (clamp)
    پیش‌فرض این DAT محدود به ۱۰۰ پیام است. با این گزینه می‌توان محدودیت را حذف یا تغییر داد.

  • Maximum Lines (maxlines)
    تعداد پیام‌ها را محدود می‌کند، پیام‌های قدیمی‌تر ابتدا حذف می‌شوند.

  • Clear Output (clear)
    تمام خطوط به جز سطر عنوان حذف می‌شوند. برای پاک کردن با پایتون:

    op("opname").par.clear.pulse()
  • Bytes Column (bytes)
    بایت‌های خام پیام را در ستونی جداگانه خروجی می‌دهد.


پارامترها – Common Page

  • Language (language)
    انتخاب زبان اسکریپت برای DAT.

  • Edit/View Extension (extension)
    انتخاب پسوند فایل برای ویرایشگرهای خارجی.

  • Custom Extension (customext)
    مشخص کردن پسوند سفارشی.

  • Word Wrap (wordwrap)
    فعال کردن شکستن خطوط برای نمایش نود.


ورودی‌های Operator

  • Input 0:

  • Input 1:


کانال‌های Info CHOP

اطلاعات اضافی SocketIO DAT از طریق Info CHOP قابل دسترسی است.

کانال‌های عمومی DAT

  • num_rows – تعداد ردیف‌ها در این DAT

  • num_cols – تعداد ستون‌ها در این DAT

کانال‌های عمومی Operator

  • total_cooks – تعداد دفعات Cook اپراتور از زمان شروع اجرا

  • cook_time – مدت زمان آخرین Cook (میلی‌ثانیه)

  • cook_frame – شماره فریم آخرین Cook نسبت به تایم‌لاین کامپوننت

  • cook_abs_frame – شماره فریم نسبت به زمان مطلق

  • cook_start_time – زمان شروع Cook در آن فریم (میلی‌ثانیه)

  • cook_end_time – زمان پایان Cook در آن فریم (میلی‌ثانیه)

  • cooked_this_frame – اگر اپراتور در این فریم Cook شده باشد مقدار ۱ دارد

  • warnings – تعداد هشدارها (در صورت وجود)

  • errors – تعداد خطاها (در صورت وجود)