chrome.socket

ब्यौरा

टीसीपी और यूडीपी कनेक्शन का इस्तेमाल करके, नेटवर्क पर डेटा भेजने और पाने के लिए, chrome.socket API का इस्तेमाल करें. ध्यान दें: Chrome 33 से, इस एपीआई का इस्तेमाल नहीं किया जा सकता. इसके बजाय, sockets.udp, sockets.tcp, और sockets.tcpServer एपीआई का इस्तेमाल किया जा सकता है.

अनुमतियां

socket

टाइप

AcceptInfo

प्रॉपर्टी

  • resultCode

    संख्या

  • socketId

    number ज़रूरी नहीं

    स्वीकार किए गए सॉकेट का आईडी.

CreateInfo

प्रॉपर्टी

  • socketId

    संख्या

    नए बनाए गए सॉकेट का आईडी.

CreateOptions

NetworkInterface

प्रॉपर्टी

  • पता

    स्ट्रिंग

    उपलब्ध IPv4/6 पता.

  • नाम

    स्ट्रिंग

    अडैप्टर का मूल नाम. *nix पर, यह आम तौर पर "eth0", "lo" वगैरह होगा.

  • prefixLength

    संख्या

    प्रीफ़िक्स की लंबाई

ReadInfo

प्रॉपर्टी

  • डेटा

    ArrayBuffer

  • resultCode

    संख्या

    read() कॉल से मिला resultCode.

RecvFromInfo

प्रॉपर्टी

  • पता

    स्ट्रिंग

    रिमोट मशीन का पता.

  • डेटा

    ArrayBuffer

  • पोर्ट

    संख्या

  • resultCode

    संख्या

    recvfrom() कॉल से मिला resultCode.

SecureOptions

प्रॉपर्टी

SocketInfo

प्रॉपर्टी

  • कनेक्ट किया गया

    बूलियन

    इससे पता चलता है कि सोकेट कनेक्ट है या नहीं.

    tcp सॉकेट के लिए, यह तब भी सही रहेगा, जब रिमोट पीयर डिसकनेक्ट हो गया हो. इसके बाद, सोकेट में डेटा पढ़ने या उसमें डेटा लिखने पर गड़बड़ी का मैसेज मिल सकता है. इससे पता चलता है कि इस सोकेट को disconnect() की मदद से डिसकनेक्ट किया जाना चाहिए.

    udp सॉकेट के लिए, इससे सिर्फ़ यह पता चलता है कि पैकेट पढ़ने और लिखने के लिए, डिफ़ॉल्ट रिमोट पता दिया गया है या नहीं.

  • localAddress

    स्ट्रिंग ज़रूरी नहीं है

    अगर सोकेट बंधा हुआ है या कनेक्ट है, तो उसमें उसका स्थानीय IPv4/6 पता होता है.

  • localPort

    number ज़रूरी नहीं

    अगर सोकेट बंधा हुआ है या कनेक्ट है, तो इसमें उसका लोकल पोर्ट शामिल होता है.

  • peerAddress

    स्ट्रिंग ज़रूरी नहीं है

    अगर सोकेट कनेक्ट है, तो इसमें पियर का IPv4/6 पता होता है.

  • peerPort

    number ज़रूरी नहीं

    अगर सोकेट कनेक्ट है, तो इसमें कनेक्ट किए गए पीयर का पोर्ट शामिल होता है.

  • socketType

    SocketType

    पास किए गए सॉकेट का टाइप. यह tcp या udp होगा.

SocketType

Enum

"tcp"

"udp"

TLSVersionConstraints

प्रॉपर्टी

  • अधिकतम

    स्ट्रिंग ज़रूरी नहीं है

  • कम से कम

    स्ट्रिंग ज़रूरी नहीं है

    TLS के कम से कम और ज़्यादा से ज़्यादा वर्शन. tls1.2 या tls1.3 का इस्तेमाल किया जा सकता है.

    tls1 और tls1.1 वैल्यू अब काम नहीं करतीं. अगर min को इनमें से किसी वैल्यू पर सेट किया जाता है, तो इसे चुपचाप tls1.2 पर क्लैंप कर दिया जाएगा. अगर max को इनमें से किसी वैल्यू या ऐसी किसी भी वैल्यू पर सेट किया जाता है जिसकी पहचान नहीं हो सकी है, तो उसे अनदेखा कर दिया जाएगा.

WriteInfo

प्रॉपर्टी

  • bytesWritten

    संख्या

    भेजे गए बाइट की संख्या या गड़बड़ी का नेगेटिव कोड.

तरीके

accept()

chrome.socket.accept(
  socketId: number,
  callback: function,
)

यह तरीका सिर्फ़ टीसीपी सॉकेट पर लागू होता है. इस सुनने वाले सर्वर सॉकेट पर कनेक्शन स्वीकार होने पर, कॉलबैक फ़ंक्शन को रजिस्टर करता है. Listen को पहले कॉल किया जाना चाहिए. अगर पहले से ही कोई चालू 'स्वीकार करें' कॉलबैक है, तो इस कॉलबैक को तुरंत ट्रिगर कर दिया जाएगा. साथ ही, resultCode के तौर पर गड़बड़ी का मैसेज दिखेगा.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (acceptInfo: AcceptInfo) => void

bind()

chrome.socket.bind(
  socketId: number,
  address: string,
  port: number,
  callback: function,
)

सॉकेट के लिए लोकल पता बांधता है. फ़िलहाल, यह टीसीपी सॉकेट के साथ काम नहीं करता.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • पता

    स्ट्रिंग

    लोकल मशीन का पता.

  • पोर्ट

    संख्या

    लोकल मशीन का पोर्ट.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

connect()

chrome.socket.connect(
  socketId: number,
  hostname: string,
  port: number,
  callback: function,
)

tcp सॉकेट के लिए, सॉकेट को रिमोट मशीन से कनेक्ट करता है. udp सॉकेट के लिए, यह डिफ़ॉल्ट पता सेट करता है. read() और write() कॉल के लिए, पैकेट इसी पते पर भेजे और पढ़े जाते हैं.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • hostname

    स्ट्रिंग

    रिमोट मशीन का होस्टनेम या आईपी पता.

  • पोर्ट

    संख्या

    रिमोट मशीन का पोर्ट.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

create()

वादा करना 
chrome.socket.create(
  type: SocketType,
  options?: CreateOptions,
  callback?: function,
)

तय किए गए टाइप का एक सॉकेट बनाता है, जो तय की गई रिमोट मशीन से कनेक्ट होगा.

पैरामीटर

  • टाइप

    SocketType

    बनाने के लिए सॉकेट का टाइप. यह ज़रूरी है कि वैल्यू tcp या udp हो.

  • विकल्प

    CreateOptions ज़रूरी नहीं

    सॉकेट के विकल्प.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

    callback पैरामीटर इस तरह दिखता है: 

    (createInfo: CreateInfo) => void

रिटर्न

  • Promise<CreateInfo>

    Chrome 121 और उसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

destroy()

chrome.socket.destroy(
  socketId: number,
)

सॉकेट को बंद कर देता है. इस्तेमाल के बाद, बनाए गए हर सॉकेट को मिटा देना चाहिए.

पैरामीटर

  • socketId

    संख्या

    socketId.

disconnect()

chrome.socket.disconnect(
  socketId: number,
)

सॉकेट को डिसकनेक्ट करता है. यूडीपी सॉकेट के लिए, disconnect कोई कार्रवाई नहीं है, लेकिन इसे कॉल करना सुरक्षित है.

पैरामीटर

  • socketId

    संख्या

    socketId.

getInfo()

वादा करना 
chrome.socket.getInfo(
  socketId: number,
  callback?: function,
)

दिए गए सॉकेट की स्थिति दिखाता है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

    callback पैरामीटर इस तरह दिखता है: 

    (result: SocketInfo) => void

रिटर्न

  • Promise<SocketInfo>

    Chrome 121 और उसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

getJoinedGroups()

chrome.socket.getJoinedGroups(
  socketId: number,
  callback: function,
)

मल्टीकास्ट ग्रुप के उन पतों को पाएं जिनसे सॉकेट फ़िलहाल जुड़ा है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (groups: string[]) => void

    • समूह

      string[]

getNetworkList()

वादा करना 
chrome.socket.getNetworkList(
  callback?: function,
)

इस सिस्टम पर मौजूद लोकल अडैप्टर के बारे में जानकारी दिखाता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन ज़रूरी नहीं

    callback पैरामीटर इस तरह दिखता है: 

    (result: NetworkInterface[]) => void

रिटर्न

  • Promise<NetworkInterface[]>

    Chrome 121 और उसके बाद के वर्शन

    प्रॉमिस सिर्फ़ मेनिफ़ेस्ट V3 और उसके बाद के वर्शन के साथ काम करते हैं. अन्य प्लैटफ़ॉर्म के लिए, कॉलबैक का इस्तेमाल करना ज़रूरी है.

joinGroup()

chrome.socket.joinGroup(
  socketId: number,
  address: string,
  callback: function,
)

मल्टीकास्ट ग्रुप में शामिल हों और उस ग्रुप से पैकेट पाना शुरू करें. इस मेथड को कॉल करने से पहले, सॉकेट UDP टाइप का होना चाहिए और किसी लोकल पोर्ट से बंधा होना चाहिए.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • पता

    स्ट्रिंग

    जिस ग्रुप में शामिल होना है उसका पता. डोमेन नेम काम नहीं करते.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

leaveGroup()

chrome.socket.leaveGroup(
  socketId: number,
  address: string,
  callback: function,
)

joinGroup का इस्तेमाल करके, उस मल्टीकास्ट ग्रुप को छोड़ें जिसमें आपने पहले शामिल हुआ था. सॉकेट को बंद करने या उससे बाहर निकलने से पहले, मल्टीकास्ट ग्रुप को छोड़ना ज़रूरी नहीं है. इसे ओएस अपने-आप कॉल करता है.

ग्रुप छोड़ने पर, राउटर स्थानीय होस्ट को मल्टीकास्ट डेटाग्राम नहीं भेज पाएगा. ऐसा तब होगा, जब होस्ट पर कोई अन्य प्रोसेस अब भी ग्रुप से जुड़ी न हो.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • पता

    स्ट्रिंग

    जिस ग्रुप को छोड़ना है उसका पता. डोमेन नेम काम नहीं करते.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

listen()

chrome.socket.listen(
  socketId: number,
  address: string,
  port: number,
  backlog?: number,
  callback: function,
)

यह तरीका सिर्फ़ टीसीपी सॉकेट पर लागू होता है. यह टूल, बताए गए पोर्ट और पते पर कनेक्शन के लिए सुनता है. इससे यह एक सर्वर सॉकेट बन जाता है और इस सॉकेट पर क्लाइंट सॉकेट फ़ंक्शन (कनेक्ट, रीड, और लिखें) का इस्तेमाल नहीं किया जा सकता.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • पता

    स्ट्रिंग

    लोकल मशीन का पता.

  • पोर्ट

    संख्या

    लोकल मशीन का पोर्ट.

  • बैकलॉग

    number ज़रूरी नहीं

    सॉकेट की सुनने की सूची की लंबाई.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

read()

chrome.socket.read(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

दिए गए कनेक्ट किए गए सॉकेट से डेटा पढ़ता है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • bufferSize

    number ज़रूरी नहीं

    रीड बफ़र का साइज़.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (readInfo: ReadInfo) => void

recvFrom()

chrome.socket.recvFrom(
  socketId: number,
  bufferSize?: number,
  callback: function,
)

यह दिए गए यूडीपी सॉकेट से डेटा पाता है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • bufferSize

    number ज़रूरी नहीं

    रिसीव बफ़र का साइज़.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (recvFromInfo: RecvFromInfo) => void

secure()

chrome.socket.secure(
  socketId: number,
  options?: SecureOptions,
  callback: function,
)

कनेक्ट किए गए टीसीपी क्लाइंट सॉकेट पर, TLS क्लाइंट कनेक्शन शुरू करें.

पैरामीटर

  • socketId

    संख्या

    इस्तेमाल करने के लिए कनेक्ट किया गया सॉकेट.

  • विकल्प

    SecureOptions ज़रूरी नहीं है

    TLS कनेक्शन के लिए पाबंदियां और पैरामीटर.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

sendTo()

chrome.socket.sendTo(
  socketId: number,
  data: ArrayBuffer,
  address: string,
  port: number,
  callback: function,
)

दिए गए पते और पोर्ट पर, दिए गए यूडीपी सॉकेट पर डेटा भेजता है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • डेटा

    ArrayBuffer

    लिखा जाने वाला डेटा.

  • पता

    स्ट्रिंग

    रिमोट मशीन का पता.

  • पोर्ट

    संख्या

    रिमोट मशीन का पोर्ट.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (writeInfo: WriteInfo) => void

setKeepAlive()

chrome.socket.setKeepAlive(
  socketId: number,
  enable: boolean,
  delay?: number,
  callback: function,
)

इससे टीसीपी कनेक्शन के लिए, 'कनेक्शन बनाए रखें' सुविधा चालू या बंद होती है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • चालू करें

    बूलियन

    अगर यह 'सही है' पर सेट है, तो 'किंगपिन' सुविधा चालू करें.

  • विलंब

    number ज़रूरी नहीं

    आखिरी डेटा पैकेट मिलने और पहली 'काइलिप्स रखें' प्रोब के बीच के सेकंड सेट करें. डिफ़ॉल्ट वैल्यू 0 है.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

setMulticastLoopbackMode()

chrome.socket.setMulticastLoopbackMode(
  socketId: number,
  enabled: boolean,
  callback: function,
)

सेट करें कि होस्ट से मल्टीकास्ट ग्रुप को भेजे गए मल्टीकास्ट पैकेट, होस्ट पर वापस भेजे जाएंगे या नहीं.

ध्यान दें: Windows और Unix जैसे सिस्टम में, setMulticastLoopbackMode का काम करने का तरीका थोड़ा अलग होता है. यह अंतर सिर्फ़ तब होता है, जब एक ही होस्ट पर एक से ज़्यादा ऐप्लिकेशन एक ही मल्टीकास्ट ग्रुप से जुड़े हों और मल्टीकास्ट लूपबैक मोड पर अलग-अलग सेटिंग हों. Windows पर, जिन ऐप्लिकेशन में लूपबैक की सुविधा बंद है उन्हें लूपबैक पैकेट नहीं मिलेंगे. वहीं, Unix जैसे सिस्टम पर, जिन ऐप्लिकेशन में लूपबैक की सुविधा बंद है वे उसी होस्ट पर मौजूद अन्य ऐप्लिकेशन को लूपबैक पैकेट नहीं भेजेंगे. MSDN देखें: http://goo.gl/6vqbj

इस तरीके को कॉल करने के लिए, मल्टीकास्ट की अनुमतियों की ज़रूरत नहीं होती.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • चालू किया गया

    बूलियन

    बताएं कि लूपबैक मोड चालू करना है या नहीं.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

setMulticastTimeToLive()

chrome.socket.setMulticastTimeToLive(
  socketId: number,
  ttl: number,
  callback: function,
)

मल्टीकास्ट ग्रुप को भेजे गए मल्टीकास्ट पैकेट का टाइम-टू-लाइव सेट करें.

इस तरीके को कॉल करने के लिए, मल्टीकास्ट की अनुमतियों की ज़रूरत नहीं होती.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • ttl

    संख्या

    'लाइव रहने का समय' वैल्यू.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: number) => void

    • नतीजा

      संख्या

setNoDelay()

chrome.socket.setNoDelay(
  socketId: number,
  noDelay: boolean,
  callback: function,
)

किसी टीसीपी कनेक्शन के लिए TCP_NODELAY को सेट या हटाता है. TCP_NODELAY सेट होने पर, Nagle का एल्गोरिदम बंद हो जाएगा.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • noDelay

    बूलियन

    अगर यह 'सही है' पर सेट है, तो Nagle का एल्गोरिदम बंद हो जाता है.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (result: boolean) => void

    • नतीजा

      बूलियन

write()

chrome.socket.write(
  socketId: number,
  data: ArrayBuffer,
  callback: function,
)

कनेक्ट किए गए दिए गए सॉकेट पर डेटा लिखता है.

पैरामीटर

  • socketId

    संख्या

    socketId.

  • डेटा

    ArrayBuffer

    लिखा जाने वाला डेटा.

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर इस तरह दिखता है: 

    (writeInfo: WriteInfo) => void