Caché DBMS 2013.1 में नया: नेटिव वेबसॉक सपोर्ट

पिछले लेख में , हमने पहले से ही नियमित सॉकेट्स के ऊपर इस प्रोटोकॉल के अपने स्वयं के सर्वर कार्यान्वयन के उदाहरण का उपयोग करके WebSocket के साथ काम करने पर चर्चा की।

Caché 2013.1 DBMS में, CSP गेटवे में अब WebSocket कनेक्शन के लिए HTML 5 विनिर्देश के लिए वेब सर्वर और HTML 5 संगत ब्राउज़र के बीच समर्थन शामिल है। यह सुविधा Apache 2.2 और बाद के संस्करण के लिए और IIS 8.0 के लिए उपलब्ध है, जो कि विंडोज सर्वर 2012 का हिस्सा है।

चूंकि Apache 2.4 पहले से ही Caché 2013.1 में बनाया गया है, हम इस पर अपने उदाहरण चलाएंगे।
क्लाइंट भाग को लागू करने के लिए, ZEN फ्रेमवर्क का उपयोग किया गया था, लेकिन आप उदाहरणों को CSP तकनीक या किसी अन्य में परिवर्तित कर सकते हैं।

तो चलिए शुरू करते हैं।

सिद्धांत

जैसा कि ऊपर उल्लेख किया गया है, अब Caché DBMS के सर्वर साइड में WebSocket को समर्थन देने के लिए सभी आंतरिक तर्क को लिया गया है। प्रोग्रामर को केवल अपना स्वयं का वर्ग बनाने की आवश्यकता है, इसे % CSP.WebSocket वर्ग से विरासत में मिला है , और इसमें कई तरीकों को ओवरराइड किया गया है।
क्लास % CSP.WebSocket का एक ऑब्जेक्ट WebSocket प्रोटोकॉल का उपयोग करके क्लाइंट और सर्वर के बीच संचार के लिए एक इवेंट हैंडलर के रूप में कार्य करता है। सभी WebSocket सर्वर को CSP.WebSocket% से विरासत में मिला है ।
% CSP.WebSocket वर्ग के तरीकों और गुणों का विस्तृत विवरण कक्षा के संदर्भ में पाया जा सकता है।
यहाँ मैं संक्षेप में उनमें से केवल कुछ का उल्लेख करूंगा:

विधि / संपत्ति	विवरण
पढ़ें ()	एक ग्राहक से डेटा प्राप्त करते हैं
लिखें ()	ग्राहक को डेटा भेजें
OnPreServer ()	PreServer ईवेंट हैंडलर: WebSocket सर्वर शुरू करने से पहले कॉल किया जाता है
OnPostServer ()	PostServer ईवेंट हैंडलर: जब WebSocket सर्वर बंद कर दिया जाता है
सर्वर ()	WebSocket सर्वर ही
एंडसर्वर ()	वेबसैट सर्वर को बंद करें
AtEnd	प्रॉपर्टी वैल्यू को सही मानती है (1) जब, पढ़ते समय, WebSocket सर्वर वर्तमान डेटा फ्रेम के अंत तक पहुँच जाता है
SharedConnection	प्रॉपर्टी यह निर्धारित करती है कि ग्राहक और वेबस्केट सर्वर के बीच सूचनाओं का आदान-प्रदान सीएसपी गेटवे के एक समर्पित कनेक्शन पर या साझा कनेक्शनों के पूल के माध्यम से होता है (अभी तक उपयोग नहीं किया गया है)

अभ्यास

आइए एक सरल उदाहरण देखें कि यह सब कैसे व्यवहार में उपयोग किया जा सकता है।
सबसे पहले, USER स्टूडियो में एक ZEN पेज बनाएं - डेमो.वेबकेट क्लास - और इसे % CSP.WebSocket वर्ग से वारिस करें:

क्लास डेमो.वेबसॉकेट का विस्तार ( % ZEN.Component.page , % CSP.WebSocket )
{

XData सामग्री [ XMLNamespace = " www.intersystems.com/zen" ]
{
< पेज xmlns = " www.intersystems.com/zen" शीर्षक = "" >
</ पृष्ठ >
}

}

JSON के साथ काम करने के लिए हम zenCSLM.js फ़ाइल शामिल करते हैं :

पैरामीटर JSINCLUDES = "zenCSLM.js" ;

हम WebSocket के माध्यम से क्लाइंट को जोड़ने और संबंधित घटनाओं को संसाधित करने के लिए तरीके लागू करते हैं:

/// यह क्लाइंट इवेंट, यदि मौजूद है, तो पेज लोड होने पर निकाल दिया जाता है।
ClientMethod onloadHandler () [ भाषा = जावास्क्रिप्ट]
{
ws = null;

url = ((window.location.protocol == 'https:' ) ? 'wss:' : 'ws:' ) + '//' + window.location.host + window.location.pathname;

wsCtor = विंडो [ 'MozWebSocket' ] ? MozWebSocket : विंडो [ 'WebSocket' ] ? WebSocket : अशक्त;

अगर (zenIsMissing (wsCtor)) zenAlert ( 'WebSocket आपके ब्राउज़र द्वारा नहीं है!' );
}

ClientMethod start () [ भाषा = जावास्क्रिप्ट]
{
अगर ( zenIsMissing (wsCtor)) {
अगर (zenIsMissing (ws)) {
ws = new wsCtor (url);

ws.onopen = function () {
zenAlert ( 'onopen \ n \ nreadyState:' , ws.readyState, '\ nbinaryType:' , ws.binaryType, '\ nbufferedAmount:' , wb.bufferedAmount);
};

ws.onmessage = function (e) {
zenAlert (e.data);
};

ws.onclose = function (e) {
zenAlert ( 'onclose \ n \ nwasClean:' , e.wasClean, '\ ncode :' , e.code, '\ nreason:' , e.reason);
ws = null;
};

ws.onerror = function (e) {
zenAlert ( 'onerror' );
};
}
}
}

चूंकि WebSocket सर्वर का कार्यान्वयन उसी पृष्ठ पर है, इसलिए प्रोटोकॉल को छोड़कर कनेक्शन स्ट्रिंग समान होगी। यानि अगर हमारे ZEN पेज के url का फॉर्म है
localhost:57772/csp/user/demo.WebSocket.cls
, तो WebSocket सर्वर के लिए यह होगा
ws://localhost:57772/csp/user/demo.WebSocket.cls

अब हमारे पेज में थोड़ा इंटरफ़ेस जोड़ें: सर्वर से डेटा कनेक्ट करने, डिस्कनेक्ट करने और भेजने के लिए कुछ बटन:

XData सामग्री [ XMLNamespace = " www.intersystems.com/zen" ]
{
< पेज xmlns = " www.intersystems.com/zen" शीर्षक = "" >
< text id = "txt" लेबल = "Text to" value = "World" /> भेजने के लिए
< बटन कैप्शन = "1. कनेक्ट करें" पर क्लिक करें = "zenPage.start ();" />
< बटन कैप्शन = "2. पाठ भेजें" onclick = "if (! zenIsMissing (ws)) ws.send (zenGetProp ('txt', 'value');") />
< बटन कैप्शन = "3. एक लंबी लाइन भेजें" onclick = "zenPage.sendLongStr (100000);" />
< बटन कैप्शन = "4.Send JSON" onclick = "zenPage.sendJSON ();" />
< बटन कैप्शन = "5.Disable" onclick = "if (! zenIsMissing (ws)) ws.close ();" />
</ पृष्ठ >
}

SendLongStr विधि कोड निम्नानुसार है:

ClientMethod sendLongStr ( N ) [ भाषा = जावास्क्रिप्ट]
{
अगर (zenIsMissing (ws)) वापसी ;

var s = 'a' ;
for ( var i = 1 ; i < N; i ++ ) s + = 'a' ;
ws.send (s);
}

SendJSON विधि कोड :

ClientMethod sendJSON () [ भाषा = जावास्क्रिप्ट]
{
अगर (zenIsMissing (ws)) वापसी ;

var obj = {
"फर्स्टनाम" : "इवान" ,
"अंतिम नाम" : "इवानोव" ,
"पता" : {
"स्ट्रीटएड्रेस" : "मॉस्को राजमार्ग 101, उपयुक्त 101" ।
"शहर" : "लेनिनग्राद" ,
"डाक कोड" : 101101
}
"फोनन्यूज" : [
"812 123-1234" ,
"916 123-4567"
]
};

ws.send (ZLM.jsonStringify (obj));
}

यह हमारे WebSocket सर्वर को लागू करने का समय है। ऐसा करने के लिए, नीचे दिखाए गए अनुसार OnPreServer , OnPostServer और सर्वर विधियों को ओवरराइड करें:

विधि OnPreServer () % स्थिति के रूप में
{
$ व्यवस्था करो । अनिर्धारित (2)

सेट ^ tmp ( $ वृद्धि ) (^ tmp), "OnPreServer" ) = ""
$ $ $ $ ठीक है
}

विधि OnPostServer () % स्थिति के रूप में
{
सेट ^ tmp ( $ वृद्धि ) (^ tmp), "OnPostServer" ) = ""
$ $ $ $ ठीक है
}

विधि सर्वर () % स्थिति के रूप में
{
{के लिए

सेट लेन = 32656
सेट डेटा = $ ZConvert (.. पढ़ें (? लेन। स्थिति । ), "मैं" , "UTF8" )

यदि $ $ $ ISOK ( स्थिति ) {

यदि डेटा = "विश्व" {
करो .. लिखो ( $ ZConvert ( "हैलो," _ डेटा _ "!" , "O" , "UTF8" ))
} ElseIf data = "bye" {

; WebSocket सर्वर का बल शटडाउन और अंतहीन लूप से बाहर निकलें
; ग्राहक पर काम करेगा onclose
करो .. एंडस्वर ()
छोड़ना

} एल्स {

#Dim obj as % RegisteredObject = $$$ NULLOREF

सेट ^ tmp = $ वृद्धि (^ tmp)

; स्ट्रिंग को ऑब्जेक्ट में बदलें
यदि $$$ ISOK ( ## वर्ग ( % ZEN.Auxiliary.jsonProvider )। % ConvertJSONToObject ( डेटा ,,। Obj ) {।

; यदि कोई त्रुटि नहीं है, तो संपत्ति मान सहेजें
सेट ^ tmp (^ tmp, "Server" , "firstName" ) = obj । firstName
सेट ^ tmp (^ tmp, "Server" , "lastName" ) = obj । lastName
सेट ^ tmp (^ tmp, "Server" , "address.streetAddress" ) = obj । पता । streetAddress
सेट ^ tmp (^ tmp, "Server" , "address.city" ) = obj । पता । शहर
सेट ^ tmp (^ tmp, "Server" , "address.postalCode" ) = obj । पता । PostalCode
सेट ^ tmp (^ tmp, "Server" , "phoneNumbers" ) = obj । फोन नं । GetAt (1)
सेट ^ tmp (^ tmp, "Server" , "phoneNumbers.2" ) = obj । फोन नं । GetAt (2)

; उपनाम बदलें
Obj सेट करें । अंतिम नाम = "सिदोरोव"

; एक और फोन जोड़ें
ओबज कर दो । फोन नं । सम्मिलित करें ( "111 111-1111" )

; ऑब्जेक्ट में दो और नए गुण जोड़ें।
Obj सेट करें । नाम = "वस्या"
Obj सेट करें । सड़क = "17 मीरा स्ट्रीट"

; हम बदले हुए ऑब्जेक्ट को एक स्ट्रिंग में परिवर्तित करते हैं और इसे क्लाइंट को वापस भेजते हैं
करो .. लिखो (.. Write2Str (। Obj ))

} एल्स {

; एक लंबी स्ट्रिंग प्राप्त करते समय डेटा सहेजें
सेट ^ tmp (^ tmp, "Server" , "longStr" ) = .. AtEnd _ ":" _ $ लंबाई ( डेटा ) _ ":" _ len
}
}
} एल्स {
छोड़ें :( $$$ GETERRORCODE ( स्थिति ) = $$$ CSPWebSocket ( बंद )
}
}
$ $ $ $ ठीक है
}

Write2Str उपयोगिता विधि का उपयोग डेटा आउटपुट को स्ट्रिंग में राइट कमांड द्वारा इकट्ठा करने के लिए किया जाता है:

ClassMethod Write2Str ( ByRef obj ) % स्ट्रिंग [ निजी ] के रूप में
{
कोशिश करो {
सेट करें TIO = $ IO , tXDEV = "| XDEV |" _ + $ नौकरी
करो {

// $$$ IsUnicode के लिए UTF-8 का उपयोग करें
ओपन tXDEV :( $ ZF (-6, $$$ XSLTLibrary , 12): "" : "S" : / HOSTNAME = "XSLT" : / IOT = $ का चयन करें ( $ $$ UUnicode : "UTF8" , 1: " : " RAW " ): / IBU = 16384: / OBU = 16384)
TXDEV का उपयोग करें

छोड़ो : $ $ $ ISERR ( obj । % टोज़न (,, "एलेओवी" ))

// किसी भी शेष आउटपुट को फ्लश करें
* -3 लिखिए

// अब एक स्ट्रिंग पढ़ें (अधिकतम संभव लंबाई तक, लंबे स्ट्रिंग के लिए 32k या ~ 4MB)
सेट करें = ""
जबकि (1) {
# DCChunk % स्ट्रिंग के रूप में
पढ़ें tChunk : 0
छोड़ो : ' $ लंबाई ( tChunk )
सेट s = s _ tChunk
}

} जबकि (0)
}} {}

TXDEV को बंद करें
Tio का उपयोग करें
से बाहर निकलें
}

यह हमारी कक्षा (Ctrl + F7) को संकलित करने और ब्राउज़र (F5) में देखने के लिए खुला रहता है।
क्रमिक रूप से बटन दबाने के बाद ^ tmp ग्लोबल की सामग्री इस प्रकार होगी:

^tmp=7
^tmp(1,"OnPreServer")=""
^tmp(2,"Server","longStr")="0:32656:32656"
^tmp(3,"Server","longStr")="0:32656:32656"
^tmp(4,"Server","longStr")="0:32656:32656"
^tmp(5,"Server","longStr")="1:2032:2032"
^tmp(6,"Server","address.city")=""
^tmp(6,"Server","address.postalCode")=101101
^tmp(6,"Server","address.streetAddress")=" ., 101, .101"
^tmp(6,"Server","firstName")=""
^tmp(6,"Server","lastName")=""
^tmp(6,"Server","phoneNumbers.1")="812 123-1234"
^tmp(6,"Server","phoneNumbers.2")="916 123-4567"
^tmp(7,"OnPostServer")=""

डेमो कोड के लिए स्रोत कोड डाउनलोड करें।