CronetEngine.Builder

const val HTTP_CACHE_DISABLED = 0: Int

تنظیم برای غیرفعال کردن حافظه پنهان HTTP. برخی از داده‌ها ممکن است هنوز به طور موقت در حافظه ذخیره شوند. به enableHttpCache ارسال می‌شود.

const val HTTP_CACHE_DISK = 3: Int

تنظیم برای فعال کردن حافظه پنهان روی دیسک، شامل داده‌های HTTP. setStoragePath باید قبل از ارسال این ثابت به enableHttpCache فراخوانی شود.

const val HTTP_CACHE_DISK_NO_HTTP = 2: Int

تنظیم برای فعال کردن حافظه پنهان روی دیسک، به استثنای داده‌های HTTP. setStoragePath باید قبل از ارسال این ثابت به enableHttpCache فراخوانی شود.

const val HTTP_CACHE_IN_MEMORY = 1: Int

تنظیم برای فعال کردن حافظه پنهان HTTP در حافظه، شامل داده‌های HTTP. به enableHttpCache ارسال شد.

Builder(context: Context!)

یک شیء Builder می‌سازد که ایجاد CronetEngine را تسهیل می‌کند. پیکربندی پیش‌فرض HTTP/2 و QUIC را فعال می‌کند، اما حافظه پنهان HTTP را غیرفعال می‌کند.

fun addPublicKeyPins(
    hostName: String!,
    pinsSha256: (Mutable)Set<ByteArray!>!,
    includeSubdomains: Boolean,
    expirationDate: Date!
): CronetEngine.Builder!

مجموعه‌ای از کلیدهای عمومی را برای یک میزبان مشخص پین می‌کند. با پین کردن مجموعه‌ای از کلیدهای عمومی، pinsSha256 ، ارتباط با hostName برای احراز هویت با یک گواهی با کلید عمومی از مجموعه کلیدهای پین شده مورد نیاز است. یک برنامه می‌تواند کلید عمومی گواهی ریشه، هر یک از گواهی‌های میانی یا گواهی ورود نهایی را پین کند. اگر هیچ یک از کلیدهای عمومی در زنجیره گواهی میزبان وجود نداشته باشد، حتی اگر میزبان سعی کند با گواهی مجاز توسط مخزن گواهی‌های مورد اعتماد دستگاه، احراز هویت کند، احراز هویت با شکست مواجه می‌شود و ارتباط امن برقرار نخواهد شد.

فراخوانی این متد چندین بار با نام میزبان یکسان، پین‌های تنظیم‌شده‌ی قبلی برای میزبان را لغو می‌کند.

اطلاعات بیشتر در مورد پین کردن کلید عمومی را می‌توانید در RFC 7469 بیابید.

fun addQuicHint(host: String!, port: Int, alternatePort: Int): CronetEngine.Builder!

اشاره‌ای اضافه می‌کند که host از QUIC پشتیبانی می‌کند. توجه داشته باشید که enableHttpCache ( HTTP_CACHE_DISK ) برای استفاده از برقراری اتصال 0-RTT بین جلسات مورد نیاز است.

fun build(): CronetEngine!

با استفاده از پیکربندی این سازنده، یک CronetEngine بسازید.

fun enableBrotli(value: Boolean): CronetEngine.Builder!

تنظیم می‌کند که آیا فشرده‌سازی Brotli فعال باشد یا خیر. در صورت فعال بودن، Brotli در هدرهای درخواست Accept-Encoding نمایش داده می‌شود. مقدار پیش‌فرض غیرفعال است.

fun enableHttp2(value: Boolean): CronetEngine.Builder!

تنظیم می‌کند که آیا پروتکل HTTP/2 فعال باشد یا خیر. مقدار پیش‌فرض فعال است.

fun enableHttpCache(cacheMode: Int, maxSize: Long): CronetEngine.Builder!

ذخیره سازی موقت داده‌های HTTP و سایر اطلاعات مانند اطلاعات سرور QUIC را فعال یا غیرفعال می‌کند.

fun enableNetworkQualityEstimator(value: Boolean): CronetEngine.Builder!

تخمین‌گر کیفیت شبکه را فعال می‌کند، که اندازه‌گیری‌های زمان رفت و برگشت (RTT) و توان عملیاتی پایین‌دست را در لایه‌های مختلف پشته شبکه جمع‌آوری و گزارش می‌کند. پس از فعال کردن تخمین‌گر، می‌توان شنونده‌های RTT و توان عملیاتی را با addRttListener و addThroughputListener اضافه و با removeRttListener و removeThroughputListener حذف کرد. تخمین‌گر فقط در صورت فعال بودن از حافظه و CPU استفاده می‌کند.

fun enablePublicKeyPinningBypassForLocalTrustAnchors(value: Boolean): CronetEngine.Builder!

فعال یا غیرفعال کردن بای‌پس پین‌گذاری کلید عمومی برای لنگرهای اعتماد محلی. غیرفعال کردن بای‌پس برای لنگرهای اعتماد محلی به شدت توصیه نمی‌شود زیرا ممکن است مانع از ارتباط برنامه با میزبان‌های پین‌شده شود. به عنوان مثال، ممکن است کاربر بخواهد با تغییر تنظیمات پروکسی دستگاه و افزودن گواهی پروکسی به لیست لنگر اعتماد محلی، تمام ترافیک را از طریق یک پروکسی فعال SSL ارسال کند. غیرفعال کردن بای‌پس به احتمال زیاد مانع از ارسال هرگونه ترافیک توسط برنامه به میزبان‌های پین‌شده می‌شود. برای اطلاعات بیشتر به بخش «پین‌گذاری کلید چگونه با پروکسی‌ها و فیلترهای محلی تعامل دارد؟» در https://www.chromium.org/Home/chromium-security/security-faq مراجعه کنید.

fun enableQuic(value: Boolean): CronetEngine.Builder!

فعال بودن پروتکل QUIC را تنظیم می‌کند. پیش‌فرض روی فعال است. اگر QUIC فعال باشد، شناسه عامل کاربر QUIC حاوی نام برنامه و نسخه Cronet به سرور ارسال می‌شود.

fun getDefaultUserAgent(): String!

یک رشته‌ی User-Agent شامل نام و نسخه برنامه، نسخه ساخت سیستم، مدل و شناسه و نسخه Cronet می‌سازد.

@ConnectionMigrationOptions.Experimental
fun setConnectionMigrationOptions(
    connectionMigrationOptions: ConnectionMigrationOptions!
): CronetEngine.Builder!

رفتار انتقال اتصال را پیکربندی می‌کند. برای جزئیات بیشتر، به مستندات ConnectionMigrationOptions و متدهای مجزای ConnectionMigrationOptions.Builder مراجعه کنید.

فقط در صورتی مرتبط است که enableQuic فعال باشد.

@DnsOptions.Experimental
fun setDnsOptions(dnsOptions: DnsOptions!): CronetEngine.Builder!

رفتار جستجوی نام میزبان را پیکربندی می‌کند. برای جزئیات بیشتر، به مستندات DnsOptions و متدهای جداگانه‌ی DnsOptions.Builder مراجعه کنید.

فقط در صورتی مرتبط است که enableQuic فعال باشد.

fun setLibraryLoader(loader: CronetEngine.Builder.LibraryLoader!): CronetEngine.Builder!

یک LibraryLoader برای بارگذاری کتابخانه بومی تنظیم می‌کند. اگر تنظیم نشود، کتابخانه با استفاده از loadLibrary بارگذاری خواهد شد.

fun setProxyOptions(proxyOptions: ProxyOptions): CronetEngine.Builder!

رفتار پروکسی را پیکربندی می‌کند. این به روش‌های مختلفی تأثیر می‌گذارد: برقراری اتصالات، UrlRequest و BidirectionalStream ). برای جزئیات بیشتر، به مستندات Proxy مراجعه کنید.

این را نباید با پیکربندی پروکسی که توسط کاربر تنظیم شده است؛ یا برخی پیکربندی‌های پروفایل سازمانی، یا (به احتمال زیاد) برخی پیکربندی‌های خودکار شبکه (مثلاً پروتکل کشف خودکار پروکسی وب) اشتباه گرفت. این معمولاً به عنوان پیکربندی پروکسی "سیستم" شناخته می‌شود. در صورت وجود، رعایت پیکربندی پروکسی سیستم اغلب برای دستیابی به اتصال محلی و/یا اینترنتی الزامی است. CronetEngine از قبل پیکربندی پروکسی سیستم را به صورت داخلی مدیریت می‌کند.

پیکربندی پروکسی تعریف‌شده از طریق این API، پیکربندی پروکسی "برنامه" نامیده می‌شود. پیکربندی پروکسی برنامه و سیستم از هم جدا هستند و مهم‌تر از همه، با هم متفاوتند. در حال حاضر، پیکربندی‌های پروکسی برنامه و سیستم کاملاً منحصر به فرد هستند: تعیین ProxyOptions پیکربندی پروکسی سیستم را در صورت وجود، لغو می‌کند. این ممکن است در برخی سناریوها که پیکربندی پروکسی سیستم وجود دارد، باعث مشکلات اتصال شود. در چنین سناریوهایی، ممکن است کاربران به اینترنت دسترسی نداشته باشند، مگر اینکه ProxyOptions با یک جایگزین نهایی، null ، پیکربندی شده باشد. به مستندات ProxyOptions مراجعه کنید.

@QuicOptions.Experimental
fun setQuicOptions(quicOptions: QuicOptions!): CronetEngine.Builder!

رفتار Cronet را هنگام استفاده از QUIC پیکربندی می‌کند. برای جزئیات بیشتر، به مستندات QuicOptions و متدهای جداگانه‌ی QuicOptions.Builder مراجعه کنید.

فقط در صورتی مرتبط است که enableQuic فعال باشد.

fun setStoragePath(value: String!): CronetEngine.Builder!

دایرکتوری را برای HTTP Cache و Cookie Storage تنظیم می‌کند. این دایرکتوری باید وجود داشته باشد.

نکته: از یک دایرکتوری ذخیره‌سازی با بیش از یک CronetEngine به طور همزمان استفاده نکنید. دسترسی به دایرکتوری ذخیره‌سازی از دسترسی همزمان توسط چندین CronetEngine پشتیبانی نمی‌کند.

fun setThreadPriority(priority: Int): CronetEngine.Builder!

اولویت نخ داخلی Cronet را تنظیم می‌کند.

fun setUserAgent(userAgent: String!): CronetEngine.Builder!

هدر User-Agent را برای همه درخواست‌ها لغو می‌کند. یک هدر User-Agent که به طور صریح تنظیم شده باشد (با استفاده از addHeader تنظیم می‌شود) با استفاده از این تابع، مقداری را که تنظیم شده است، لغو می‌کند.

protected val mParsedExperimentalOptions: JSONObject!

نمایش JSON از گزینه‌های آزمایشی.