CronetEngine

const val ACTIVE_REQUEST_COUNT_UNKNOWN = -1: Int

ไม่ทราบค่าของจำนวนคำขอที่ใช้งานอยู่

const val CONNECTION_METRIC_UNKNOWN = -1: Int

ไม่ทราบค่าของเมตริกการเชื่อมต่อ

const val EFFECTIVE_CONNECTION_TYPE_2G = 3: Int

การประมาณประเภทการเชื่อมต่อที่มีประสิทธิภาพคือ 2G

const val EFFECTIVE_CONNECTION_TYPE_3G = 4: Int

การประมาณประเภทการเชื่อมต่อที่มีประสิทธิภาพคือ 3G

const val EFFECTIVE_CONNECTION_TYPE_4G = 5: Int

การประมาณประเภทการเชื่อมต่อที่มีประสิทธิภาพคือ 4G

const val EFFECTIVE_CONNECTION_TYPE_OFFLINE = 1: Int

อุปกรณ์ออฟไลน์อยู่

const val EFFECTIVE_CONNECTION_TYPE_SLOW_2G = 2: Int

การประมาณประเภทการเชื่อมต่อที่มีประสิทธิภาพคือ 2G ที่ช้า

const val EFFECTIVE_CONNECTION_TYPE_UNKNOWN = 0: Int

ไม่ทราบค่าประมาณของประเภทการเชื่อมต่อที่มีประสิทธิภาพ

const val UNBIND_NETWORK_HANDLE = -1: Long

ค่าที่จะใช้เพื่อยกเลิกการเชื่อมโยงเครือข่ายก่อนหน้า

fun addRequestFinishedListener(listener: RequestFinishedInfo.Listener!): Unit

ลงทะเบียน Listener ที่จะเรียกใช้หลังจากสิ้นสุดคำขอแต่ละรายการพร้อมข้อมูลคำขอ

ระบบจะเรียกใช้ Listener ใน java.util.concurrent.Executor ที่ Listener ระบุ

fun addRttListener(listener: NetworkQualityRttListener!): Unit

ลงทะเบียน Listener ที่จะเรียกใช้ทุกครั้งที่เครื่องมือประมาณคุณภาพเครือข่ายพบเวลาไปกลับของตัวอย่าง ต้องเรียกใช้หลังจาก enableNetworkQualityEstimator และจะส่งข้อยกเว้นหากไม่เรียกใช้ ระบบอาจบันทึกเวลาในการรับส่งแพ็กเก็ตที่เลเยอร์ต่างๆ ของสแต็กเครือข่าย ซึ่งรวมถึง TCP, QUIC และที่เลเยอร์คำขอ URL ระบบจะเรียก Listener ใน java.util.concurrent.Executor ที่ส่งไปยัง enableNetworkQualityEstimator

fun addThroughputListener(listener: NetworkQualityThroughputListener!): Unit

ลงทะเบียน Listener ที่จะได้รับการเรียกใช้เมื่อใดก็ตามที่เครื่องมือประมาณคุณภาพเครือข่ายพบการวัดปริมาณงานตัวอย่าง ต้องเรียกใช้หลังจาก enableNetworkQualityEstimator ระบบจะคำนวณการสังเกตการณ์ปริมาณงานโดยการวัดไบต์ที่อ่านผ่านอินเทอร์เฟซเครือข่ายที่ใช้งานอยู่ ในช่วงเวลาที่ได้รับคำตอบจาก URL อย่างน้อย 1 รายการ ระบบจะเรียก Listener ใน java.util.concurrent.Executor ที่ส่งไปยัง enableNetworkQualityEstimator

fun bindToNetwork(networkHandle: Long): Unit

เชื่อมโยงเครื่องมือกับแฮนเดิลเครือข่ายที่ระบุ คำขอทั้งหมดที่สร้างผ่านเครื่องมือนี้จะใช้เครือข่ายที่เชื่อมโยงกับแฮนเดิลนี้ หากเครือข่ายนี้ตัดการเชื่อมต่อ คำขอทั้งหมดจะล้มเหลว โดยข้อผิดพลาดที่แน่นอนจะขึ้นอยู่กับขั้นตอนการประมวลผลคำขอเมื่อเครือข่ายตัดการเชื่อมต่อ คุณสามารถรับแฮนเดิลเครือข่ายได้ผ่าน Network#getNetworkHandle พร้อมใช้งานตั้งแต่ Android Marshmallow เป็นต้นไปเท่านั้น

fun configureNetworkQualityEstimatorForTesting(
    useLocalHostRequests: Boolean,
    useSmallerResponses: Boolean,
    disableOfflineCheck: Boolean
): Unit

กำหนดค่าตัวประมาณคุณภาพเครือข่ายสำหรับการทดสอบ ต้องเรียกใช้ฟังก์ชันนี้ก่อนที่จะเพิ่ม Listener เวลาในการรับส่งและอัตราการส่งข้อมูล และหลังจากที่เปิดใช้ Estimator คุณภาพเครือข่ายแล้ว

abstract fun createURLStreamHandlerFactory(): URLStreamHandlerFactory!

สร้าง URLStreamHandlerFactory เพื่อจัดการการเข้าชม HTTP และ HTTPS คุณติดตั้งอินสแตนซ์ของคลาสนี้ได้ผ่าน setURLStreamHandlerFactory ซึ่งจะใช้ CronetEngine นี้โดยค่าเริ่มต้นสำหรับคำขอทั้งหมดที่สร้างผ่าน openConnection

Cronet ไม่ใช้ฟีเจอร์ HTTP บางอย่างที่ระบบมีให้ ดังนี้

• แคช HTTP ที่ติดตั้งผ่าน HttpResponseCache.install()
• วิธีการตรวจสอบสิทธิ์ HTTP ที่ติดตั้งผ่าน setDefault
• ที่เก็บคุกกี้ HTTP ที่ติดตั้งผ่าน setDefault

แม้ว่า Cronet จะรองรับและแนะนำให้ใช้คำขอที่ใช้โปรโตคอล HTTPS แต่ก็ไม่รองรับ HttpsURLConnection API การไม่รองรับนี้ยังรวมถึงการไม่ใช้ฟีเจอร์ HTTPS บางอย่างที่ระบบมีให้ด้วย

• โปรแกรมตรวจสอบชื่อโฮสต์ HTTPS ที่ติดตั้งผ่าน HttpsURLConnection.setDefaultHostnameVerifier()
• โรงงานซ็อกเก็ต HTTPS ที่ติดตั้งผ่าน HttpsURLConnection.setDefaultSSLSocketFactory()

fun getActiveRequestCount(): Int

แสดงผลจำนวนคำขอที่ใช้งานอยู่

คำขอจะ "ใช้งานอยู่" ใน UrlRequest.start() โดยสมมติว่าเมธอดนั้นไม่ได้ส่งข้อยกเว้น โดยจะไม่มีการใช้งานเมื่อการเรียกกลับทั้งหมดเสร็จสิ้นแล้ว และจะเรียกกลับเพิ่มเติมในอนาคตไม่ได้ ในทางปฏิบัติ นั่นหมายความว่าคำขอจะไม่ได้ใช้งานเมื่อ onSucceeded/onCanceled/onFailed แสดงผลและผู้ฟังที่เสร็จสิ้นคำขอทั้งหมดแสดงผล วงจรคำขอของ Cronet เพื่อดูข้อมูลเพิ่มเติม

fun getDownstreamThroughputKbps(): Int

แสดงการประมาณปริมาณงานดาวน์สตรีม (เป็นกิโลบิตต่อวินาที) ที่คำนวณโดยเครื่องมือประมาณคุณภาพเครือข่าย ตั้งค่าเป็น CONNECTION_METRIC_UNKNOWN หากค่าไม่พร้อมใช้งาน ต้องเรียกใช้หลังจาก enableNetworkQualityEstimator และจะส่งข้อยกเว้นหากไม่เรียกใช้

fun getEffectiveConnectionType(): Int

แสดงค่าประมาณของประเภทการเชื่อมต่อที่มีประสิทธิภาพซึ่งคำนวณโดยเครื่องมือประมาณคุณภาพเครือข่าย โทรหา enableNetworkQualityEstimator เพื่อเริ่มคำนวณค่านี้

fun getHttpRttMs(): Int

แสดงค่าประมาณ RTT ของ HTTP (เป็นมิลลิวินาที) ที่คำนวณโดยตัวประมาณคุณภาพเครือข่าย ตั้งค่าเป็น CONNECTION_METRIC_UNKNOWN หากค่าไม่พร้อมใช้งาน ต้องเรียกใช้หลังจาก enableNetworkQualityEstimator และจะส่งข้อยกเว้นหากไม่เรียกใช้

fun getTransportRttMs(): Int

แสดงผลค่าประมาณ RTT ของการรับส่ง (เป็นมิลลิวินาที) ที่คำนวณโดยเครื่องมือประมาณคุณภาพเครือข่าย ตั้งค่าเป็น CONNECTION_METRIC_UNKNOWN หากค่าไม่พร้อมใช้งาน ต้องเรียกใช้หลังจาก enableNetworkQualityEstimator และจะส่งข้อยกเว้นหากไม่เรียกใช้

abstract fun newUrlRequestBuilder(
    url: String!,
    callback: UrlRequest.Callback!,
    executor: Executor!
): UrlRequest.Builder!

สร้างเครื่องมือสร้างสำหรับ UrlRequest การเรียกกลับทั้งหมดสำหรับออบเจ็กต์ UrlRequest ที่สร้างขึ้นจะเรียกใช้ในเธรดของ executor executor ต้องไม่เรียกใช้ Task ในเธรดที่เรียก execute เพื่อป้องกันไม่ให้การดำเนินการเครือข่ายถูกบล็อกและทำให้เกิดข้อยกเว้นในระหว่างการปิดระบบ

abstract fun openConnection(url: URL!): URLConnection!

สร้างการเชื่อมต่อใหม่กับทรัพยากรที่ระบุโดย URLurl

หมายเหตุ: การติดตั้งใช้งาน java.net.HttpURLConnection ของ Cronet มีข้อจำกัดบางอย่าง โปรดดูรายละเอียดที่ createURLStreamHandlerFactory

fun removeRequestFinishedListener(listener: RequestFinishedInfo.Listener!): Unit

นำเครื่องมือฟังคำขอที่เสร็จสมบูรณ์แล้วออก

fun removeRttListener(listener: NetworkQualityRttListener!): Unit

นำ Listener ของเวลาไปกลับออกหากลงทะเบียนกับ addRttListener ไว้ก่อนหน้านี้ ควรเรียกใช้หลังจากเพิ่ม NetworkQualityRttListener เพื่อหยุดรับการสังเกตการณ์

fun removeThroughputListener(listener: NetworkQualityThroughputListener!): Unit

นำ Listener ของปริมาณงานออก ควรเรียกใช้หลังจากเพิ่ม NetworkQualityThroughputListener ด้วย addThroughputListener เพื่อหยุดรับข้อมูลการสังเกต

abstract fun shutdown(): Unit

ปิด CronetEngine หากไม่มีคำขอที่ใช้งานอยู่ ไม่เช่นนั้นจะเกิดข้อยกเว้น

เรียกใช้ในเธรดเครือข่ายไม่ได้ - เธรดที่ Cronet เรียกใช้ใน Executor (ซึ่งแตกต่างจากเธรดที่ Executor เรียกใช้การเรียกกลับ) อาจบล็อกจนกว่าจะล้างข้อมูลทรัพยากรทั้งหมดของ CronetEngine

fun startNetLogToDisk(dirPath: String!, logAll: Boolean, maxSize: Int): Unit

เริ่มการบันทึก NetLog ไปยังไดเรกทอรีที่ระบุโดยมีขนาดที่จำกัด NetLog จะมีเหตุการณ์ที่ปล่อยออกมาจาก CronetEngine ที่ใช้งานอยู่ทั้งหมด NetLog มีประโยชน์สำหรับการแก้ไขข้อบกพร่อง เมื่อหยุดการบันทึกแล้ว stopNetLog ระบบจะเขียนข้อมูลลงใน netlog.json ใน dirPath หากการบันทึกหยุดชะงัก คุณสามารถต่อไฟล์ที่พบในไดเรกทอรีย่อย .inprogress ด้วยตนเองได้โดยใช้ https://chromium.googlesource.com/chromium/src/+/main/net/tools/stitch_net_log_files.py คุณดูบันทึกได้โดยใช้เบราว์เซอร์ Chrome ไปที่ chrome://net-internals/#import

abstract fun startNetLogToFile(fileName: String!, logAll: Boolean): Unit

เริ่มการบันทึก NetLog ลงในไฟล์ NetLog จะมีเหตุการณ์ที่ปล่อยออกมาจาก CronetEngine ที่ใช้งานอยู่ทั้งหมด NetLog มีประโยชน์สำหรับการแก้ไขข้อบกพร่อง คุณดูไฟล์ได้โดยใช้เบราว์เซอร์ Chrome ไปที่ chrome://net-internals/#import

abstract fun stopNetLog(): Unit

หยุดการบันทึก NetLog และล้างข้อมูลไฟล์ลงในดิสก์ หากเซสชันการบันทึกไม่ได้ดำเนินการอยู่ ระบบจะไม่สนใจการเรียกนี้