کتابخانه‌ی استاندارد · شبکه

جی آر پی سی grpc

سرور و کارخواه gRPC روی HTTP/2: فراخوان ساده و جریانی، فراداده و کدهای وضعیت.

واردسازی جی آر پی سی

نام آرگومان‌ها شناسه‌ی خود کد است و معادل فارسی ندارد؛ گونه‌ها، کلیدواژه‌ها و نام بسته‌ها با معادل فارسی نوشته می‌شوند.

gRPC روشی برای فراخوان دور است که روی HTTP/2 کار می‌کند و در سرویس‌های ریزخدمت رایج است. در سمت سرور هر متد را با مسیرش، مثل /demo.Greeter/SayHello، ثبت می‌کنید؛ تابع متد پیام کارخواه را با دریافت می‌خواند، با ارسال جواب می‌دهد و با تنظیم وضعیت یا شکست تمامش می‌کند.

در سمت کارخواه، فراخوان یگانه یک درخواست ساده است و برای جریان‌ها شروع فراخوان، ارسال پیام، دریافت پیام و پایان فراخوان را به کار می‌برید. پیام‌ها بایت‌اند؛ آن‌ها را معمولاً با پروتوباف می‌سازید.

وقتی طرف مقابل از پیش gRPC می‌فهمد، یا میان سرویس‌ها پیام نوع‌دار و جریان می‌خواهید، gRPC را انتخاب کنید. برای پروتکلی ساده‌تر که روی TCP ساده، ورودی و خروجی استاندارد یا یک مسیر HTTP هم کار می‌کند، فراخوان دور (JSON-RPC و MessagePack-RPC) را ببینید.

پیش از این‌که روی سمت سرور چیزی بسازید، محدودیت‌هایش را بدانید:

  • سرور در هر لحظه به یک اتصال و روی آن اتصال به یک فراخوان پاسخ می‌دهد: هر متد تا آخر اجرا می‌شود و بعد جریان بعدی خوانده می‌شود. یک فراخوان جریانی طولانی همه‌ی صدازننده‌های دیگر را معطل می‌کند. این برای ابزارهای داخلی، آزمون‌ها و سرویس‌های سبک مناسب است.
  • سرور فقط HTTP/2 بی‌رمز (h2c) می‌فهمد. برای پذیرفتن TLS یک پراکسی مثل nginx یا Envoy جلویش بگذارید. کارخواه با اتصال امن می‌تواند TLS را به کار ببرد.
  • وضعیت اتصال در یک متغیر سراسری نگه داشته می‌شود؛ پس خدمت به اتصال نباید هم‌زمان در چند نخ اجرا شود.

فراخوان یگانه با پیام‌های protobuf

سرویس‌های واقعی gRPC پیام protobuf رد و بدل می‌کنند، نه رشته‌ی ساده. پیام فهرستی از فیلدهاست و هر فیلد به شکل یک برچسب (شماره‌ی فیلد و نوع سیم) و پس از آن مقدار نوشته می‌شود؛ پروتوباف آن‌ها را می‌نویسد و می‌خواند. نمونه‌ی زیر متد Users.Get را تعریف می‌کند که پیامی با شناسه‌ی کاربر در فیلد ۱ می‌گیرد و با پیام کاربر پاسخ می‌دهد: شناسه در فیلد ۱ و نام در فیلد ۲. سرور و کارخواه در یک برنامه اجرا می‌شوند و سرور روی درگاهی است که سیستم انتخاب می‌کند.

grpc-guide-protobuf.salam
واردسازی جی آر پی سی
واردسازی کدگذاری.پروتوباف
واردسازی فشرده سازی
واردسازی همگام سازی

ناپایا سرور := جی آر پی سی.سرور جدید(۰)
ناپایا آماده := همگام سازی.گروه انتظار جدید()

تابع رمزگذاری کاربر(شناسه: صحیح، نام: رشته): فشرده سازی.بافر بایت:
    ناپایا ب := فشرده سازی.بافر بایت جدید()
    پروتوباف.نوشتن برچسب(ب، ۱، پروتوباف.نوع سیم متغیر)
    پروتوباف.نوشتن عدد متغیر(ب، شناسه برگردان طبیعی۶۴)
    پروتوباف.نوشتن برچسب(ب، ۲، پروتوباف.نوع سیم طول‌دار)
    پروتوباف.نوشتن رشته طول‌دار(ب، نام)
    برگشت ب
پایان

تابع دریافت کاربر(ف: صحیح۶۴):
    ناپایا رسید := نادرست
    درخواست := جی آر پی سی.دریافت(ف، رسید)
    ناپایا خواننده := فشرده سازی.خواننده از بافر(درخواست)
    ناپایا فیلد := ۰
    ناپایا سیم := ۰
    ناپایا شناسه := ۰
    تلاش:
        پروتوباف.خواندن برچسب(خواننده، فیلد، سیم)
        شناسه = پروتوباف.خواندن عدد متغیر(خواننده) برگردان صحیح
    گرفتن خطا اشکال:
        جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت آرگومان نامعتبر، اشکال.به رشته())
        برگشت
    پایان
    اگر فیلد != ۱:
        جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت آرگومان نامعتبر، "فیلد ۱ با شناسه‌ی کاربر لازم است")
        برگشت
    پایان
    اگر شناسه != ۷:
        جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت یافت نشد، "کاربر " + شناسه + " وجود ندارد")
        برگشت
    پایان
    ناپایا پاسخ := رمزگذاری کاربر(۷، "مریم")
    _ := جی آر پی سی.ارسال(ف، پاسخ)
    فشرده سازی.آزادسازی بافر(پاسخ)
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع اجرای سرور():
    _ := جی آر پی سی.گوش دادن(سرور)
    همگام سازی.اتمام(آماده)
    _ := جی آر پی سی.خدمت به تعداد(سرور، ۱)
پایان

تابع پرسیدن(کانال &: جی آر پی سی.کانال، شناسه: صحیح) خطادار:
    ناپایا درخواست := فشرده سازی.بافر بایت جدید()
    پروتوباف.نوشتن برچسب(درخواست، ۱، پروتوباف.نوع سیم متغیر)
    پروتوباف.نوشتن عدد متغیر(درخواست، شناسه برگردان طبیعی۶۴)
    ناپایا وضعیت := جی آر پی سی.وضعیت {}
    پاسخ := جی آر پی سی.فراخوان یگانه(کانال، "/users.Users/Get"، درخواست، جی آر پی سی.فراداده جدید()، وضعیت)
    فشرده سازی.آزادسازی بافر(درخواست)
    اگر وارونه جی آر پی سی.وضعیت موفق(وضعیت):
        سرچاپ "کاربر"، شناسه، "یعنی"، جی آر پی سی.متن وضعیت(وضعیت)
        برگشت
    پایان
    ناپایا خواننده := فشرده سازی.خواننده از بافر(پاسخ)
    ناپایا فیلد := ۰
    ناپایا سیم := ۰
    تلاش پروتوباف.خواندن برچسب(خواننده، فیلد، سیم)
    شماره := تلاش پروتوباف.خواندن عدد متغیر(خواننده)
    تلاش پروتوباف.خواندن برچسب(خواننده، فیلد، سیم)
    سرچاپ "کاربر"، شماره، "نامش"، تلاش پروتوباف.خواندن رشته طول‌دار(خواننده)، "است"
پایان

تابع ریشه خطادار:
    جی آر پی سی.ثبت متد(جی آر پی سی.مسیر متد("users.Users"، "Get")، دریافت کاربر)
    همگام سازی.افزودن(آماده، ۱)
    ن := نخ‌ساز(اجرای سرور)
    همگام سازی.انتظار(آماده)
    ناپایا کانال := جی آر پی سی.اتصال("127.0.0.1"، جی آر پی سی.درگاه(سرور))
    جی آر پی سی.تنظیم مهلت(کانال، ۵۰۰۰)
    تلاش پرسیدن(کانال، ۷)
    تلاش پرسیدن(کانال، ۸)
    جی آر پی سی.بستن کانال(کانال)
    نخ‌پیوند(ن)
    جی آر پی سی.توقف سرور(سرور)
پایان
خروجیکاربر 7 نامش مریم است کاربر 8 یعنی NOT_FOUND: کاربر 8 وجود ندارد

مسیر متد مسیر /users.Users/Get را از نام سرویس و متد می‌سازد، و این مسیر باید با پرونده‌ی .proto طرف مقابل یکی باشد. وقتی درخواست نادرست است یا رکورد وجود ندارد، متد به‌جای فرستادن پیام شکست را با یک کد وضعیت صدا می‌زند. کارخواه پیش از خواندن پاسخ وضعیت موفق را بررسی می‌کند و متن وضعیت توضیح یک‌خطی‌ای مثل NOT_FOUND: کاربر 8 وجود ندارد می‌دهد.

نوشتن دستی فیلدها برای پیام‌های کوچک ایرادی ندارد. برای یک API بزرگ‌تر، پروتوباف.تولید با سرویس‌ها پرونده‌ی .proto را به ساختارهای سلام با تابع‌های Marshal و Unmarshal و کد سرویس تبدیل می‌کند تا شماره‌ی فیلدها فقط در یک جا باشد.

نشانه در فراداده و کدهای وضعیت خطا

gRPC اعتبارنامه‌ها و مقدارهای ویژه‌ی هر فراخوان را به شکل فراداده می‌فرستد؛ فراداده نام gRPC برای سرآیندهای HTTP/2 است. کارخواه با افزودن فراداده یک مدخل می‌افزاید و متد آن را با دریافت فراداده(فراداده فراخوان(ف)، ...) می‌خواند. کد وضعیت را بر اساس این‌که چه چیزی خراب شده انتخاب کنید: وضعیت احراز نشده وقتی اعتبارنامه‌ی معتبری نرسیده، و وضعیت دسترسی رد شد وقتی صدازننده شناخته شده اما اجازه ندارد.

grpc-guide-auth.salam
واردسازی جی آر پی سی
واردسازی همگام سازی
واردسازی فشرده سازی

ناپایا سرور := جی آر پی سی.سرور جدید(۰)
ناپایا آماده := همگام سازی.گروه انتظار جدید()

تابع موجودی(ف: صحیح۶۴):
    ناپایا رسید := نادرست
    حساب := جی آر پی سی.دریافت متن(ف، رسید)
    نشانه := جی آر پی سی.دریافت فراداده(جی آر پی سی.فراداده فراخوان(ف)، "authorization")
    اگر نشانه == "":
        جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت احراز نشده، "نشانه فرستاده نشده")
        برگشت
    پایان
    اگر نشانه != "Bearer good-token":
        جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت دسترسی رد شد، "این نشانه اجازه‌ی خواندن " + حساب + " را ندارد")
        برگشت
    پایان
    _ := جی آر پی سی.ارسال متن(ف، حساب + ": 1250")
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع اجرای سرور():
    _ := جی آر پی سی.گوش دادن(سرور)
    همگام سازی.اتمام(آماده)
    _ := جی آر پی سی.خدمت به تعداد(سرور، ۱)
پایان

تابع ریشه:
    جی آر پی سی.ثبت متد("/bank.Accounts/Balance"، موجودی)
    همگام سازی.افزودن(آماده، ۱)
    ن := نخ‌ساز(اجرای سرور)
    همگام سازی.انتظار(آماده)
    ناپایا کانال := جی آر پی سی.اتصال("127.0.0.1"، جی آر پی سی.درگاه(سرور))
    جی آر پی سی.تنظیم مهلت(کانال، ۵۰۰۰)
    هر نشانه در [""، "Bearer old-token"، "Bearer good-token"]:
        ناپایا فراداده := جی آر پی سی.فراداده جدید()
        اگر نشانه != "":
            _ := جی آر پی سی.افزودن فراداده(فراداده، "authorization"، نشانه)
        پایان
        ناپایا وضعیت := جی آر پی سی.وضعیت {}
        پاسخ := جی آر پی سی.فراخوان یگانه(کانال، "/bank.Accounts/Balance"، فشرده سازی.بافر از رشته("acc-42")، فراداده، وضعیت)
        اگر جی آر پی سی.وضعیت موفق(وضعیت):
            سرچاپ "موفق:"، فشرده سازی.بافر به رشته(پاسخ)
        وگرنه:
            سرچاپ جی آر پی سی.نام وضعیت(وضعیت.کد)، "(" + وضعیت.کد + "):"، وضعیت.پیام
        پایان
    پایان
    جی آر پی سی.بستن کانال(کانال)
    نخ‌پیوند(ن)
    جی آر پی سی.توقف سرور(سرور)
پایان
خروجیUNAUTHENTICATED (16): نشانه فرستاده نشده PERMISSION_DENIED (7): این نشانه اجازه‌ی خواندن acc-42 را ندارد موفق: acc-42: 1250

کلیدهای فراداده با حروف کوچک‌اند. مقدار دودویی باید کلیدی داشته باشد که به -bin ختم شود و با افزودن فراداده دودویی افزوده می‌شود. کارخواه‌ها اغلب روی وضعیت ناموجود خودکار دوباره تلاش می‌کنند اما روی خطای احراز هویت هرگز؛ پس کد درست برای صدازننده مهم است، نه فقط برای گزارش‌ها.

جریان از سوی کارخواه: پیام‌های بسیار، یک پاسخ

متدی که با ثبت متد جریانی(مسیر، تابع، درست، نادرست) ثبت شود، جریانی از کارخواه می‌گیرد و یک بار پاسخ می‌دهد؛ برای بارگذاری و دسته‌ای از خوانش‌ها مناسب است. متد دریافت را در یک حلقه صدا می‌زند تا وقتی رسید نادرست شود، که یعنی کارخواه آخرین پیامش را فرستاده. در طرف کارخواه، شروع فراخوان فراخوان را باز می‌کند، ارسال پیام هر پیام را می‌فرستد و آخرین آرگومانش پیام پایانی را مشخص می‌کند، بعد دریافت پیام پاسخ را می‌خواند و پایان فراخوان وضعیت را برمی‌گرداند.

grpc-guide-stream.salam
واردسازی جی آر پی سی
واردسازی فشرده سازی
واردسازی همگام سازی

ناپایا سرور := جی آر پی سی.سرور جدید(۰)
ناپایا آماده := همگام سازی.گروه انتظار جدید()

تابع جمع کل(ف: صحیح۶۴):
    ناپایا جمع := ۰
    ناپایا تعداد := ۰
    ناپایا ادامه := درست
    تا ادامه:
        ناپایا رسید := نادرست
        خوانش := جی آر پی سی.دریافت متن(ف، رسید)
        اگر وارونه رسید:
            ادامه = نادرست
        وگرنه:
            جمع += خوانش.به صحیح()
            تعداد++
        پایان
    پایان
    _ := جی آر پی سی.ارسال متن(ف، "" + تعداد + " خوانش، جمع " + جمع)
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع اجرای سرور():
    _ := جی آر پی سی.گوش دادن(سرور)
    همگام سازی.اتمام(آماده)
    _ := جی آر پی سی.خدمت به تعداد(سرور، ۱)
پایان

تابع ریشه:
    جی آر پی سی.ثبت متد جریانی("/meter.Meter/Upload"، جمع کل، درست، نادرست)
    همگام سازی.افزودن(آماده، ۱)
    ن := نخ‌ساز(اجرای سرور)
    همگام سازی.انتظار(آماده)
    ناپایا کانال := جی آر پی سی.اتصال("127.0.0.1"، جی آر پی سی.درگاه(سرور))
    جی آر پی سی.تنظیم مهلت(کانال، ۵۰۰۰)
    فراخوان := جی آر پی سی.شروع فراخوان(کانال، "/meter.Meter/Upload"، جی آر پی سی.فراداده جدید())
    خوانش‌ها := ["12"، "7"، "30"، "1"]
    هر ش، خ در خوانش‌ها:
        ناپایا پیام := فشرده سازی.بافر از رشته(خ)
        _ := جی آر پی سی.ارسال پیام(کانال، فراخوان، پیام، ش == طول(خوانش‌ها) - ۱)
        فشرده سازی.آزادسازی بافر(پیام)
    پایان
    ناپایا رسید := نادرست
    پاسخ := جی آر پی سی.دریافت پیام(کانال، فراخوان، رسید)
    سرچاپ فشرده سازی.بافر به رشته(پاسخ)
    سرچاپ جی آر پی سی.متن وضعیت(جی آر پی سی.پایان فراخوان(کانال، فراخوان))
    جی آر پی سی.بستن کانال(کانال)
    نخ‌پیوند(ن)
    جی آر پی سی.توقف سرور(سرور)
پایان
خروجی4 خوانش، جمع 50 OK

اگر از پیش نمی‌دانید کدام پیام آخر است، همه را با نادرست بفرستید و در پایان بستن ارسال را صدا بزنید. برای جهت برعکس، یعنی جریان از سوی سرور، با نادرست، درست ثبت کنید، در متد چند بار ارسال را صدا بزنید و در کارخواه با دریافت پیام بخوانید تا رسید نادرست شود.

کدام شکل فراخوان برای کدام کار

شکلثبت باکارخواه صدا می‌زند
یک درخواست، یک پاسخثبت متدفراخوان یگانه، یا فراخوان یگانه متنی برای متن
چند درخواست، یک پاسخثبت متد جریانی(مسیر، تابع، درست، نادرست)شروع فراخوان، ارسال پیام، دریافت پیام، پایان فراخوان
یک درخواست، چند پاسخثبت متد جریانی(مسیر، تابع، نادرست، درست)شروع فراخوان، ارسال پیام با درست، سپس دریافت پیام در حلقه
هر دو جهتثبت متد جریانی(مسیر، تابع، درست، درست)همان تابع‌ها، به نوبت فرستادن و خواندن

برای رسیدن به یک سرویس عمومی روی TLS، کانال را با اتصال امن(میزبان، ۴۴۳) باز کنید؛ بقیه‌ی کار همان است. فعال‌سازی فشرده‌سازی پیام‌هایی را که کارخواه می‌فرستد فشرده می‌کند.

گونه‌ها

کانال Channel

ساختار کانال
کانال به یک سرور gRPC روی HTTP/2.
نامانگلیسیگونهتوضیح
اتصالconnاچ تی تی پی۲.اتصال اچ تی تی پی۲اتصال HTTP/2.
نشانی سرورauthorityرشته = ""میزبان و درگاه.
طرحschemeرشته = "http"طرح: http یا https.
شناسه کارخواهuser_agentرشته = "salam-grpc/1.0"شناسه‌ی کارخواه.
مهلتtimeout_msصحیح = 0مهلت هر فراخوان.
فشرده‌سازیuse_gzipمنطقی = نادرستپیام‌ها فشرده فرستاده شوند.
مکان‌نماهاcursorsجدول مکان‌نماهاجای خواندن هر جریان.
سالمokمنطقی = نادرستسالم است.
آخرین خطاlast_errorرشته = ""آخرین خطا.
grpc-Calls.salam
واردسازی جی آر پی سی
واردسازی فشرده سازی
واردسازی همگام سازی

ناپایا سرور := جی آر پی سی.سرور جدید(۰)
ناپایا آماده := همگام سازی.گروه انتظار جدید()

تابع سلام(ف: صحیح۶۴):
    ناپایا سالم := نادرست
    نام := جی آر پی سی.دریافت متن(ف، سالم)
    _ := جی آر پی سی.ارسال متن(ف، "سلام " + نام)
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع شمارش(ف: صحیح۶۴):
    ناپایا سالم := نادرست
    _ := جی آر پی سی.دریافت(ف، سالم)
    تکرار ۳ در ش:
        _ := جی آر پی سی.ارسال(ف، فشرده سازی.بافر از رشته("" + (۳ - ش)))
    پایان
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع ردیابی(ف: صحیح۶۴):
    ناپایا سالم := نادرست
    _ := جی آر پی سی.دریافت متن(ف، سالم)
    _ := جی آر پی سی.ارسال متن(ف، جی آر پی سی.دریافت فراداده(جی آر پی سی.فراداده فراخوان(ف)، "x-trace") + " " + جی آر پی سی.مسیر فراخوان(ف))
    جی آر پی سی.تنظیم وضعیت(ف، جی آر پی سی.وضعیت بدون خطا، "")
پایان

تابع ممنوع(ف: صحیح۶۴):
    جی آر پی سی.شکست(ف، جی آر پی سی.وضعیت دسترسی رد شد، "توکن منقضی شده")
پایان

تابع اجرای سرور():
    _ := جی آر پی سی.گوش دادن(سرور)
    همگام سازی.اتمام(آماده)
    _ := جی آر پی سی.خدمت به تعداد(سرور، ۱)
پایان

تابع ریشه:
    مسیر سلام := جی آر پی سی.مسیر متد("demo.Greeter"، "SayHello")
    سرچاپ مسیر سلام
    جی آر پی سی.ثبت متد(مسیر سلام، سلام)
    جی آر پی سی.ثبت متد جریانی("/demo.Greeter/Countdown"، شمارش، نادرست، درست)
    جی آر پی سی.ثبت متد("/demo.Greeter/Trace"، ردیابی)
    جی آر پی سی.ثبت متد("/demo.Greeter/Admin"، ممنوع)
    سرچاپ جی آر پی سی.تعداد متدها()، جی آر پی سی.متد دارد(مسیر سلام)
    همگام سازی.افزودن(آماده، ۱)
    ن := نخ‌ساز(اجرای سرور)
    همگام سازی.انتظار(آماده)

    ناپایا ک := جی آر پی سی.اتصال("127.0.0.1"، جی آر پی سی.درگاه(سرور))
    جی آر پی سی.تنظیم مهلت(ک، ۵۰۰۰)
    سرچاپ جی آر پی سی.کانال معتبر(ک)
    ناپایا نتیجه := جی آر پی سی.وضعیت {}
    سرچاپ جی آر پی سی.فراخوان یگانه متنی(ک، مسیر سلام، "مریم"، نتیجه)، جی آر پی سی.وضعیت موفق(نتیجه)

    ف := جی آر پی سی.شروع فراخوان(ک، "/demo.Greeter/Countdown"، جی آر پی سی.فراداده جدید())
    _ := جی آر پی سی.ارسال پیام(ک، ف، فشرده سازی.بافر از رشته("go")، درست)
    ناپایا ادامه := درست
    تا ادامه:
        ناپایا سالم := نادرست
        پ := جی آر پی سی.دریافت پیام(ک، ف، سالم)
        اگر وارونه سالم:
            ادامه = نادرست
        وگرنه:
            سرچاپ "پیام:"، فشرده سازی.بافر به رشته(پ)
        پایان
    پایان
    سرچاپ جی آر پی سی.تعداد فراداده(جی آر پی سی.سرآیندهای فراخوان(ک، ف))
    سرچاپ جی آر پی سی.متن وضعیت(جی آر پی سی.پایان فراخوان(ک، ف))

    ناپایا ف‌د := جی آر پی سی.فراداده جدید()
    _ := جی آر پی سی.افزودن فراداده(ف‌د، "x-trace"، "t-42")
    ناپایا نتیجه۲ := جی آر پی سی.وضعیت {}
    پاسخ := جی آر پی سی.فراخوان یگانه(ک، "/demo.Greeter/Trace"، فشرده سازی.بافر از رشته("x")، ف‌د، نتیجه۲)
    سرچاپ فشرده سازی.بافر به رشته(پاسخ)

    ف۲ := جی آر پی سی.شروع فراخوان(ک، "/demo.Greeter/Trace"، ف‌د)
    _ := جی آر پی سی.ارسال پیام(ک، ف۲، فشرده سازی.بافر از رشته("y")، نادرست)
    _ := جی آر پی سی.بستن ارسال(ک، ف۲)
    ناپایا سالم۲ := نادرست
    _ := جی آر پی سی.دریافت پیام(ک، ف۲، سالم۲)
    _ := جی آر پی سی.پایان فراخوان(ک، ف۲)
    سرچاپ سالم۲، جی آر پی سی.دنباله‌های فراخوان(ک، ف۲).مدخل‌ها.طول() >= ۰

    ناپایا نتیجه۳ := جی آر پی سی.وضعیت {}
    _ := جی آر پی سی.فراخوان یگانه متنی(ک، "/demo.Greeter/Admin"، ""، نتیجه۳)
    سرچاپ نتیجه۳.کد، نتیجه۳.پیام، جی آر پی سی.نام وضعیت(نتیجه۳.کد)
    ناپایا نتیجه۴ := جی آر پی سی.وضعیت {}
    _ := جی آر پی سی.فراخوان یگانه متنی(ک، "/demo.Greeter/Nope"، ""، نتیجه۴)
    سرچاپ جی آر پی سی.متن وضعیت(نتیجه۴)
    جی آر پی سی.بستن کانال(ک)
    نخ‌پیوند(ن)
    جی آر پی سی.توقف سرور(سرور)
    جی آر پی سی.بازنشانی متدها()
    سرچاپ جی آر پی سی.تعداد متدها()
پایان
خروجی/demo.Greeter/SayHello 4 true true سلام مریم true پیام: 3 پیام: 2 پیام: 1 0 OK t-42 /demo.Greeter/Trace true true 7 توکن منقضی شده PERMISSION_DENIED UNIMPLEMENTED: unknown method /demo.Greeter/Nope 0

وضعیت Status

ساختار وضعیت
وضعیت پایانی یک فراخوان.
نامانگلیسیگونهتوضیح
کدcodeصحیح = 0کد.
پیامmessageرشته = ""پیام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

مدخل فراداده MDEntry

ساختار مدخل فراداده
یک مدخل فراداده.
نامانگلیسیگونهتوضیح
کلیدkeyرشته = ""کلید.
مقدارvalueرشته = ""مقدار.
دودوییbinaryمنطقی = نادرستدودویی است.
grpc-Wire.salam
واردسازی جی آر پی سی
واردسازی فشرده سازی
واردسازی شبکه.اچ تی تی پی۲

تابع ریشه:
    یک := جی آر پی سی.قاب‌بندی پیام متنی("سلام")
    سرچاپ یک.طول، فشرده سازی.دریافت بایت(یک، ۰)، فشرده سازی.دریافت بایت(یک، ۴)
    ناپایا همه := فشرده سازی.بافر بایت جدید()
    فشرده سازی.افزودن بافر(همه، یک)
    فشرده سازی.افزودن بافر(همه، جی آر پی سی.قاب‌بندی پیام(فشرده سازی.بافر از رشته("دو")، نادرست))
    فشرده سازی.افزودن بافر(همه، جی آر پی سی.قاب‌بندی فشرده(فشرده سازی.بافر از رشته("سه سه سه سه سه")، درست))
    سرچاپ جی آر پی سی.تعداد پیام‌ها(همه)، جی آر پی سی.پیام کامل دارد(همه، ۰)
    ناپایا جا := ۰
    ناپایا سالم := نادرست
    تا جی آر پی سی.پیام کامل دارد(همه، جا):
        پ := جی آر پی سی.پیام بعدی(همه، جا، سالم)
        سرچاپ سالم، فشرده سازی.بافر به رشته(پ)
    پایان

    ناپایا ف := جی آر پی سی.فراداده جدید()
    _ := جی آر پی سی.افزودن فراداده(ف، "authorization"، "Bearer abc")
    _ := جی آر پی سی.افزودن فراداده(ف، "x-tag"، "a")
    _ := جی آر پی سی.افزودن فراداده(ف، "x-tag"، "b")
    _ := جی آر پی سی.افزودن فراداده دودویی(ف، "trace-bin"، "\x01\x02")
    سرچاپ جی آر پی سی.تعداد فراداده(ف)، جی آر پی سی.فراداده دارد(ف، "x-tag")، جی آر پی سی.دریافت فراداده(ف، "authorization")
    سرچاپ جی آر پی سی.دریافت همه فراداده(ف، "x-tag").طول()
    سرچاپ جی آر پی سی.کلید فراداده(ف، ۳)، جی آر پی سی.مقدار فراداده(ف، ۳).طول()
    ناپایا سر := اچ تی تی پی۲.فهرست سرآیندها {}
    جی آر پی سی.فراداده به سرآیند(ف، سر)
    سرچاپ اچ تی تی پی۲.تعداد سرآیندها(سر)، اچ تی تی پی۲.دریافت سرآیند(سر، "trace-bin")
    سرچاپ جی آر پی سی.تعداد فراداده(جی آر پی سی.فراداده از سرآیند(سر))

    خ := جی آر پی سی.وضعیت جدید(جی آر پی سی.وضعیت یافت نشد، "کاربر ۴۲ نیست")
    سرچاپ جی آر پی سی.وضعیت موفق(خ)، جی آر پی سی.متن وضعیت(خ)
    پیام := جی آر پی سی.کدگذاری پیام وضعیت("۱۰۰٪ کامل")
    سرچاپ پیام، جی آر پی سی.کدگشایی پیام وضعیت(پیام)
    سرچاپ جی آر پی سی.قالب‌بندی کد وضعیت(۱۴)، جی آر پی سی.تجزیه کد وضعیت("14")، جی آر پی سی.تجزیه کد وضعیت("x")
    سرچاپ جی آر پی سی.نام وضعیت(جی آر پی سی.وضعیت گذشت مهلت)، جی آر پی سی.نام وضعیت(جی آر پی سی.وضعیت احراز نشده)
    سرچاپ جی آر پی سی.وضعیت لغو شده، جی آر پی سی.وضعیت ناشناخته، جی آر پی سی.وضعیت آرگومان نامعتبر، جی آر پی سی.وضعیت از پیش موجود
    سرچاپ جی آر پی سی.وضعیت منابع تمام شد، جی آر پی سی.وضعیت پیش‌شرط ناموفق، جی آر پی سی.وضعیت قطع شده، جی آر پی سی.وضعیت خارج از محدوده
    سرچاپ جی آر پی سی.وضعیت پیاده‌سازی نشده، جی آر پی سی.وضعیت خطای داخلی، جی آر پی سی.وضعیت ناموجود، جی آر پی سی.وضعیت از دست رفتن داده
    سرچاپ جی آر پی سی.نوع محتوا، جی آر پی سی.نوع محتوای پروتو، جی آر پی سی.نوع محتوای جیسون
    سرچاپ جی آر پی سی.بدون فشرده‌سازی، جی آر پی سی.فشرده‌سازی جی زیپ، جی آر پی سی.بیشینه قاب‌ها، جی آر پی سی.بیشینه اندازه پیام
پایان
خروجی13 0 8 3 true true سلام true دو true سه سه سه سه سه 4 true Bearer abc 2 trace-bin 2 4 AQI= 4 false NOT_FOUND: کاربر ۴۲ نیست %DB%B1%DB%B0%DB%B0%D9%AA %DA%A9%D8%A7%D9%85%D9%84 ۱۰۰٪ کامل 14 14 2 DEADLINE_EXCEEDED UNAUTHENTICATED 1 2 3 6 8 9 10 11 12 13 14 15 application/grpc application/grpc+proto application/grpc+json 0 1 100000 4194304

فراداده Metadata

ساختار فراداده
فراداده‌ی یک فراخوان، مثل سرآیندهای HTTP.
نامانگلیسیگونهتوضیح
مدخل‌هاitemsوکتور<مدخل فراداده>مدخل‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

زمینه فراخوان CallCtx

ساختار زمینه فراخوان
وضعیت یک فراخوان در سرور.
نامانگلیسیگونهتوضیح
شناسه جریانstream_idصحیح = 0شناسه‌ی جریان.
مسیر متدmethodرشته = ""مسیر متد.
سرآیندهاheadersاچ تی تی پی۲.فهرست سرآیندهاسرآیندها.
داده دریافتیrecvفشرده سازی.بافر بایتداده‌ی دریافتی.
جای خواندنrecv_posصحیح = 0جای خواندن.
کارخواه تمام‌کردهclient_doneمنطقی = نادرستکارخواه ارسال را بسته.
سرآیندهای فرستاده‌شدهsent_headersمنطقی = نادرستسرآیندهای پاسخ فرستاده شده.
وضعیتstatusوضعیتوضعیت.
مشغولbusyمنطقی = نادرستدر استفاده.
شکست‌خوردهfailedمنطقی = نادرستشکست خورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

جدول فراخوان‌ها CallTable

ساختار جدول فراخوان‌ها
جدول فراخوان‌ها.
نامانگلیسیگونهتوضیح
فراخوان‌هاitemsوکتور<زمینه فراخوان>فراخوان‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

توصیف متد MethodDesc

ساختار توصیف متد
توصیف یک متد ثبت‌شده.
نامانگلیسیگونهتوضیح
مسیرpathرشته = ""مسیر.
تابعfnصحیح۶۴ = 0تابع.
جریان کارخواهclient_streamمنطقی = نادرستکارخواه جریانی می‌فرستد.
جریان سرورserver_streamمنطقی = نادرستسرور جریانی می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

جدول متدها MethodTable

ساختار جدول متدها
جدول متدها.
نامانگلیسیگونهتوضیح
متدهاitemsوکتور<توصیف متد>متدها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

مکان‌نما Cursor

ساختار مکان‌نما
جای خواندن یک جریان.
نامانگلیسیگونهتوضیح
شناسه جریانstream_idصحیح = 0شناسه‌ی جریان.
جای خواندنposصحیح = 0جای خواندن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

جدول مکان‌نماها CursorTable

ساختار جدول مکان‌نماها
جدول مکان‌نماها.
نامانگلیسیگونهتوضیح
مکان‌نماهاitemsوکتور<مکان‌نما>مکان‌نماها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

سرور جی آر پی سی Server

ساختار سرور جی آر پی سی
سرور gRPC روی HTTP/2 بی‌رمز.
نامانگلیسیگونهتوضیح
درگاهportصحیح = 0درگاه.
سوکت گوش‌دهندهlisten_fdصحیح۶۴ = -1سوکت گوش دادن.
فعالrunningمنطقی = نادرستدر حال اجرا.
شمار اتصال پاسخ‌دادهservedصحیح = 0شمار اتصال‌های پاسخ‌داده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

پایاها و متغیرها

وضعیت بدون خطا GRPC_OK

پایا وضعیت بدون خطا: صحیح۳۲ = 0
کد وضعیت: موفق.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

وضعیت لغو شده GRPC_CANCELLED

پایا وضعیت لغو شده: صحیح۳۲ = 1
کد وضعیت: لغو شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت ناشناخته GRPC_UNKNOWN

پایا وضعیت ناشناخته: صحیح۳۲ = 2
کد وضعیت: خطای ناشناخته.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت آرگومان نامعتبر GRPC_INVALID_ARGUMENT

پایا وضعیت آرگومان نامعتبر: صحیح۳۲ = 3
کد وضعیت: آرگومان نامعتبر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت گذشت مهلت GRPC_DEADLINE_EXCEEDED

پایا وضعیت گذشت مهلت: صحیح۳۲ = 4
کد وضعیت: مهلت تمام شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت یافت نشد GRPC_NOT_FOUND

پایا وضعیت یافت نشد: صحیح۳۲ = 5
کد وضعیت: یافت نشد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت از پیش موجود GRPC_ALREADY_EXISTS

پایا وضعیت از پیش موجود: صحیح۳۲ = 6
کد وضعیت: از پیش هست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت دسترسی رد شد GRPC_PERMISSION_DENIED

پایا وضعیت دسترسی رد شد: صحیح۳۲ = 7
کد وضعیت: اجازه ندارید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

وضعیت منابع تمام شد GRPC_RESOURCE_EXHAUSTED

پایا وضعیت منابع تمام شد: صحیح۳۲ = 8
کد وضعیت: منابع یا سهمیه تمام شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت پیش‌شرط ناموفق GRPC_FAILED_PRECONDITION

پایا وضعیت پیش‌شرط ناموفق: صحیح۳۲ = 9
کد وضعیت: سامانه در وضعیت لازم نیست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت قطع شده GRPC_ABORTED

پایا وضعیت قطع شده: صحیح۳۲ = 10
کد وضعیت: به‌خاطر تداخل قطع شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت خارج از محدوده GRPC_OUT_OF_RANGE

پایا وضعیت خارج از محدوده: صحیح۳۲ = 11
کد وضعیت: بیرون از بازه.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت پیاده‌سازی نشده GRPC_UNIMPLEMENTED

پایا وضعیت پیاده‌سازی نشده: صحیح۳۲ = 12
کد وضعیت: متد پیاده نشده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت خطای داخلی GRPC_INTERNAL

پایا وضعیت خطای داخلی: صحیح۳۲ = 13
کد وضعیت: خطای داخلی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت ناموجود GRPC_UNAVAILABLE

پایا وضعیت ناموجود: صحیح۳۲ = 14
کد وضعیت: سرویس در دسترس نیست؛ می‌شود دوباره تلاش کرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت از دست رفتن داده GRPC_DATA_LOSS

پایا وضعیت از دست رفتن داده: صحیح۳۲ = 15
کد وضعیت: داده از دست رفت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت احراز نشده GRPC_UNAUTHENTICATED

پایا وضعیت احراز نشده: صحیح۳۲ = 16
کد وضعیت: احراز هویت نشده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

نوع محتوا GRPC_CONTENT_TYPE

پایا نوع محتوا: رشته = "application/grpc"
نوع محتوای gRPC.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

نوع محتوای پروتو GRPC_CONTENT_TYPE_PROTO

پایا نوع محتوای پروتو: رشته = "application/grpc+proto"
نوع محتوا با پروتوباف.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

نوع محتوای جیسون GRPC_CONTENT_TYPE_JSON

پایا نوع محتوای جیسون: رشته = "application/grpc+json"
نوع محتوا با جیسون.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

بدون فشرده‌سازی GRPC_COMP_NONE

پایا بدون فشرده‌سازی: صحیح۳۲ = 0
بدون فشرده‌سازی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

فشرده‌سازی جی زیپ GRPC_COMP_GZIP

پایا فشرده‌سازی جی زیپ: صحیح۳۲ = 1
فشرده‌سازی gzip.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

بیشینه قاب‌ها GRPC_MAX_FRAMES

پایا بیشینه قاب‌ها: صحیح۳۲ = 100000
بیشترین قابی که برای یک فراخوان خوانده می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

بیشینه اندازه پیام GRPC_MAX_MESSAGE

پایا بیشینه اندازه پیام: صحیح۳۲ = 4194304
بیشترین اندازه‌ی یک پیام: ۴ مگابایت.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

تابع‌ها

اتصال Dial

تابع اتصال(host: رشته، port: صحیح): کانال
کانال بی‌رمز (h2c)؛ برای سرورهای داخلی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

اتصال امن DialTLS

تابع اتصال امن(host: رشته، port: صحیح): کانال
کانال امن با TLS و ALPN h2.
grpc-TLS.salam
واردسازی جی آر پی سی
واردسازی شبکه.تی سی پی

تابع پژواک(ف: صحیح۶۴):
    ناپایا سالم := نادرست
    _ := جی آر پی سی.ارسال متن(ف، جی آر پی سی.دریافت متن(ف، سالم))
پایان

تابع ریشه:
    ناپایا ک := جی آر پی سی.اتصال امن("api.example.com"، ۴۴۳)
    اگر وارونه جی آر پی سی.کانال معتبر(ک):
        سرچاپ جی آر پی سی.خطای کانال(ک)
        برگشت
    پایان
    جی آر پی سی.فعال‌سازی فشرده‌سازی(ک، درست)
    ناپایا نتیجه := جی آر پی سی.وضعیت {}
    سرچاپ جی آر پی سی.فراخوان یگانه متنی(ک، "/demo.Echo/Say"، "سلام"، نتیجه)
    جی آر پی سی.بستن کانال(ک)

    جی آر پی سی.ثبت متد("/demo.Echo/Say"، پژواک)
    ناپایا س := جی آر پی سی.سرور جدید(۵۰۰۵۱)
    اگر جی آر پی سی.گوش دادن(س):
        جی آر پی سی.خدمت(س)
    پایان
    ا := تی سی پی.شماره گیری("127.0.0.1"، ۵۰۰۵۲)
    _ := جی آر پی سی.خدمت به اتصال(ا.توصیفگر)
پایان

کانال معتبر ChannelOk

تابع کانال معتبر(ch: کانال): منطقی
کانال سالم است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

خطای کانال ChannelError

تابع خطای کانال(ch: کانال): رشته
آخرین خطای کانال.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-TLS.salam

تنظیم مهلت SetTimeout

تابع تنظیم مهلت(ch &: کانال، ms: صحیح)
مهلت فراخوان‌ها بر حسب میلی‌ثانیه؛ با سرآیند grpc-timeout به سرور هم گفته می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

فعال‌سازی فشرده‌سازی SetGzip

تابع فعال‌سازی فشرده‌سازی(ch &: کانال، enable: منطقی)
فشرده‌سازی gzip پیام‌ها را روشن یا خاموش می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-TLS.salam

بستن کانال CloseChannel

تابع بستن کانال(ch &: کانال)
کانال را می‌بندد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

شروع فراخوان StartCall

تابع شروع فراخوان(ch &: کانال، path: رشته، md: فراداده): صحیح
فراخوانی را روی مسیر متد آغاز می‌کند و شناسه‌ی جریان را برمی‌گرداند؛ برای فراخوان‌های جریانی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

ارسال پیام SendMessage

تابع ارسال پیام(ch &: کانال، sid: صحیح، msg: فشرده سازی.بافر بایت، last: منطقی): منطقی
یک پیام می‌فرستد؛ با درست در آخرین پیام، ارسال بسته می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

بستن ارسال CloseSend

تابع بستن ارسال(ch &: کانال، sid: صحیح): منطقی
به سرور می‌گوید پیام دیگری نمی‌آید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

دریافت پیام RecvMessage

تابع دریافت پیام(ch &: کانال، sid: صحیح، ok &: منطقی): فشرده سازی.بافر بایت
پیام بعدی را می‌خواند؛ اگر پیامی نمانده، سالم نادرست می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

پایان فراخوان FinishCall

تابع پایان فراخوان(ch &: کانال، sid: صحیح): وضعیت
فراخوان را تمام می‌کند و وضعیت نهایی سرور را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

سرآیندهای فراخوان CallHeaders

تابع سرآیندهای فراخوان(ch: کانال، sid: صحیح): فراداده
فراداده‌ای که سرور در سرآیندها فرستاد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

دنباله‌های فراخوان CallTrailers

تابع دنباله‌های فراخوان(ch: کانال، sid: صحیح): فراداده
فراداده‌ای که سرور در پایان فرستاد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

فراخوان یگانه UnaryCall

تابع فراخوان یگانه(ch &: کانال، path: رشته، req: فشرده سازی.بافر بایت، md: فراداده، st &: وضعیت): فشرده سازی.بافر بایت
فراخوان ساده: یک پیام می‌فرستد و یک پاسخ می‌گیرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

فراخوان یگانه متنی UnaryCallStr

تابع فراخوان یگانه متنی(ch &: کانال، path: رشته، req: رشته، st &: وضعیت): رشته
مثل تابع بالا، با پیام متنی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

وضعیت جدید NewStatus

تابع وضعیت جدید(code: صحیح، message: رشته): وضعیت
وضعیت با کد و پیام.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

وضعیت موفق StatusOk

تابع وضعیت موفق(s: وضعیت): منطقی
وضعیت موفق است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

مسیر متد MethodPath

تابع مسیر متد(service: رشته، method: رشته): رشته
مسیر متد از نام سرویس و متد، مثل /demo.Greeter/SayHello.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

قاب‌بندی پیام FrameMessage

تابع قاب‌بندی پیام(msg: فشرده سازی.بافر بایت، compressed: منطقی): فشرده سازی.بافر بایت
پیام را با سرآیند ۵ بایتی gRPC قاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

قاب‌بندی فشرده FrameMessageGzip

تابع قاب‌بندی فشرده(msg: فشرده سازی.بافر بایت، use_gzip: منطقی): فشرده سازی.بافر بایت
پیام را قاب می‌کند و اگر بخواهید فشرده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

قاب‌بندی پیام متنی FrameMessageStr

تابع قاب‌بندی پیام متنی(msg: رشته): فشرده سازی.بافر بایت
متن را قاب می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

پیام کامل دارد HasMessage

تابع پیام کامل دارد(data: فشرده سازی.بافر بایت، pos: صحیح): منطقی
از این جا یک پیام کامل در داده هست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

پیام بعدی NextMessage

تابع پیام بعدی(data: فشرده سازی.بافر بایت، pos &: صحیح، ok &: منطقی): فشرده سازی.بافر بایت
پیام بعدی را می‌خواند و جا را جلو می‌برد؛ پیام فشرده باز می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

تعداد پیام‌ها MessageCount

تابع تعداد پیام‌ها(data: فشرده سازی.بافر بایت): صحیح
شمار پیام‌های کامل.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

فراداده جدید NewMetadata

تابع فراداده جدید(): فراداده
فراداده‌ی خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

افزودن فراداده MDAdd

تابع افزودن فراداده(md &: فراداده، key: رشته، value: رشته): منطقی
مدخل متنی می‌افزاید؛ کلید با حروف کوچک ذخیره می‌شود و کلیدهای رزرو، مثل content-type، رد می‌شوند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

افزودن فراداده دودویی MDAddBinary

تابع افزودن فراداده دودویی(md &: فراداده، key: رشته، value: رشته): منطقی
مدخل دودویی می‌افزاید؛ کلید باید به -bin تمام شود و مقدار با بیس۶۴ فرستاده می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

دریافت فراداده MDGet

تابع دریافت فراداده(md: فراداده، key: رشته): رشته
نخستین مقدار یک کلید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

فراداده دارد MDHas

تابع فراداده دارد(md: فراداده، key: رشته): منطقی
کلید هست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

دریافت همه فراداده MDGetAll

تابع دریافت همه فراداده(md: فراداده، key: رشته): وکتور<رشته>
همه‌ی مقدارهای یک کلید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

تعداد فراداده MDCount

تابع تعداد فراداده(md: فراداده): صحیح
شمار مدخل‌ها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

کلید فراداده MDKeyAt

تابع کلید فراداده(md: فراداده، i: صحیح): رشته
کلید مدخل n.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

مقدار فراداده MDValueAt

تابع مقدار فراداده(md: فراداده، i: صحیح): رشته
مقدار مدخل n.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

فراداده به سرآیند MDToHeaders

تابع فراداده به سرآیند(md: فراداده، hl &: اچ تی تی پی۲.فهرست سرآیندها)
فراداده را به سرآیندهای HTTP/2 می‌افزاید.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

فراداده از سرآیند MDFromHeaders

تابع فراداده از سرآیند(hl: اچ تی تی پی۲.فهرست سرآیندها): فراداده
فراداده را از سرآیندهای HTTP/2 درمی‌آورد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

نام وضعیت StatusName

تابع نام وضعیت(code: صحیح): رشته
نام کد وضعیت، مثل NOT_FOUND.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

کدگذاری پیام وضعیت EncodeStatusMessage

تابع کدگذاری پیام وضعیت(msg: رشته): رشته
پیام وضعیت را برای سرآیند grpc-message کدگذاری درصدی می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

کدگشایی پیام وضعیت DecodeStatusMessage

تابع کدگشایی پیام وضعیت(msg: رشته): رشته
پیام وضعیت را کدگشایی می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

قالب‌بندی کد وضعیت FormatStatusCode

تابع قالب‌بندی کد وضعیت(code: صحیح): رشته
کد وضعیت به شکل متن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

تجزیه کد وضعیت ParseStatusCode

تابع تجزیه کد وضعیت(text: رشته): صحیح
کد وضعیت از متن؛ اگر نامعتبر باشد، UNKNOWN.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Wire.salam

متن وضعیت StatusString

تابع متن وضعیت(s: وضعیت): رشته
وضعیت به شکل NAME: message.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

سرور جدید NewServer

تابع سرور جدید(port: صحیح): سرور جی آر پی سی
سرور تازه؛ درگاه صفر یعنی یک درگاه آزاد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

ثبت متد RegisterMethod

تابع ثبت متد(path: رشته، fn: صحیح۶۴)
تابعی را برای یک متد ساده ثبت می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

ثبت متد جریانی RegisterStreamMethod

تابع ثبت متد جریانی(path: رشته، fn: صحیح۶۴، client_stream: منطقی، server_stream: منطقی)
تابعی را برای متد جریانی ثبت می‌کند و می‌گوید کدام سو جریانی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

تعداد متدها MethodCount

تابع تعداد متدها(): صحیح
شمار متدها.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

متد دارد HasMethod

تابع متد دارد(path: رشته): منطقی
متد ثبت شده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

بازنشانی متدها ResetMethods

تابع بازنشانی متدها()
همه‌ی متدها را حذف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

مسیر فراخوان CallPath

تابع مسیر فراخوان(slot: صحیح۶۴): رشته
مسیر متد فراخوان جاری.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

فراداده فراخوان CallMetadata

تابع فراداده فراخوان(slot: صحیح۶۴): فراداده
فراداده‌ای که کارخواه فرستاد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

دریافت Recv

تابع دریافت(slot: صحیح۶۴، ok &: منطقی): فشرده سازی.بافر بایت
پیام بعدی کارخواه را می‌خواند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

دریافت متن RecvStr

تابع دریافت متن(slot: صحیح۶۴، ok &: منطقی): رشته
پیام بعدی به شکل متن.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

ارسال Send

تابع ارسال(slot: صحیح۶۴، msg: فشرده سازی.بافر بایت): منطقی
پیامی به کارخواه می‌فرستد؛ در متد جریانی چند بار.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

ارسال متن SendStr

تابع ارسال متن(slot: صحیح۶۴، msg: رشته): منطقی
پیام متنی می‌فرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

تنظیم وضعیت SetStatus

تابع تنظیم وضعیت(slot: صحیح۶۴، code: صحیح، message: رشته)
وضعیت پایانی فراخوان را تعیین می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

شکست Fail

تابع شکست(slot: صحیح۶۴، code: صحیح، message: رشته)
فراخوان را با کد و پیام خطا تمام می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

گوش دادن Listen

تابع گوش دادن(s &: سرور جی آر پی سی): منطقی
گوش دادن را آغاز می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

درگاه Port

تابع درگاه(s: سرور جی آر پی سی): صحیح
درگاهی که واقعاً گرفته شد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

خدمت به اتصال ServeConn

تابع خدمت به اتصال(fd: صحیح۶۴): صحیح
به فراخوان‌های یک اتصال، یکی پس از دیگری، پاسخ می‌دهد تا کارخواه آن را ببندد یا GOAWAY بفرستد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-TLS.salam

خدمت به تعداد ServeCount

تابع خدمت به تعداد(s &: سرور جی آر پی سی، n: صحیح): صحیح
به n اتصال، یکی پس از دیگری، پاسخ می‌دهد و تعداد کل را برمی‌گرداند. اگر لازم باشد، اول خودش گوش دادن را صدا می‌زند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

خدمت Serve

تابع خدمت(s &: سرور جی آر پی سی)
تا وقتی توقف سرور صدا زده نشده، به اتصال‌ها یکی‌یکی پاسخ می‌دهد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam

توقف سرور StopServer

تابع توقف سرور(s &: سرور جی آر پی سی)
سرور را متوقف می‌کند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: grpc-Calls.salam