개체 내장 개체

개체 WebSocket

WebSocket 패킷 프로토콜 변환 프로세서

Http 프로토콜을 WebSocket 패킷 프로토콜 메시지로 변환하는 데 사용됩니다. 생성 방법 :

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
var ws = require('ws'); var http = require('http'); var serv = new http.Server(8811, ws.upgrade((conn) => { conn.onmessage = msg => { conn.send(new Date()); }; })); serv.run(r => 0); var sock = new ws.Socket('ws://127.0.0.1:8811'); sock.on('open', () => { setInterval(() => { sock.send('get date'); }, 1000); }); sock.onmessage = evt => { console.log(evt.data); }

계승

건설자

WebSocket

WebSocket 생성자

1 2 3
new WebSocket(String url, String protocol = "", String origin = "");

호출 매개 변수 :

  • url : 문자열, 연결된 서버 지정
  • protocol : 문자열, 핸드 셰이크 프로토콜을 지정합니다. 기본값은 ""입니다.
  • origin : String, 핸드 셰이크 중에 시뮬레이션 할 origin 지정합니다. 기본값은 ""입니다.

WebSocket 생성자

1 2
new WebSocket(String url, Object opts);

호출 매개 변수 :

  • url : 문자열, 연결된 서버 지정
  • opts : 개체, 연결 옵션, 기본값은 {}입니다.

opts에는 요청 된 추가 옵션이 포함되어 있으며 지원되는 콘텐츠는 다음과 같습니다.

1 2 3 4 5 6 7 8
{ "protocol": "", // 指定握手协议,缺省为空 "origin": "", // 指定握手时模拟的源,缺省为空 "perMessageDeflate": true, // 指定是否支持压缩,缺省支持 "maxPayload": 67108864, // 指定最大数据包尺寸,缺省为 67108864 "httpClient": hc, // 自定义 httpClient 对象,缺省使用全局 httpClient "headers": // 指定 http(s) 连接时携带的 header,缺省为 {}, }

정적 속성

defaultMaxListeners

정수, 기본 전역 최대 리스너 수

1
static Integer WebSocket.defaultMaxListeners;

회원 속성

url

문자열, 현재 개체에 연결된 서버 쿼리

1
readonly String WebSocket.url;

protocol

문자열, 현재 개체가 연결될 때 프로토콜을 쿼리합니다.

1
readonly String WebSocket.protocol;

origin

문자열, 현재 개체 연결의 소스를 쿼리합니다.

1
readonly String WebSocket.origin;

readyState

정수, 현재 개체의 연결 상태 쿼리, ws 참조

1
readonly Integer WebSocket.readyState;

onopen

함수, 쿼리 및 바인딩 연결 성공 이벤트, on ( "open", func);

1
Function WebSocket.onopen;

onmessage

on ( "message", func와 동일) 상대방의 메시지 수신 이벤트 기능, 쿼리 및 바인딩;

1
Function WebSocket.onmessage;

onclose

on ( "close", func);에 해당하는 연결 종료 이벤트를 함수, 쿼리 및 바인딩합니다.

1
Function WebSocket.onclose;

onerror

함수, 쿼리 및 바인딩 오류 이벤트, on ( "error", func);

1
Function WebSocket.onerror;

회원 기능

close

현재 연결을 닫습니다.이 작업은 CLOSE 패킷을 상대방에게 보내고 상대방이 응답 할 때까지 기다립니다.

1 2
WebSocket.close(Integer code = 1000, String reason = "");

호출 매개 변수 :

  • code : 정수, 닫을 코드 지정, 허용되는 값은 3000-4999 또는 1000, 기본값은 1000입니다.
  • reason : 문자열, 닫는 이유를 지정합니다. 기본값은 ""입니다.

send

상대방에게 문자 보내기

1
WebSocket.send(String data);

호출 매개 변수 :

  • data : 문자열, 보낼 텍스트 지정

이진 데이터 조각을 상대방에게 보냅니다.

1
WebSocket.send(Buffer data);

호출 매개 변수 :

  • data : Buffer , 전송 된 바이너리 데이터 지정

ref

fibjs 프로세스가 종료되지 않도록하고 오브젝트 바인딩 중에 fibjs 프로세스가 종료되지 않도록합니다.

1
WebSocket WebSocket.ref();

반환 결과 :

  • WebSocket , 현재 객체 반환

unref

fibjs 프로세스가 종료되도록 허용하고 오브젝트 바인딩 중에 fibjs 프로세스가 종료되도록 허용

1
WebSocket WebSocket.unref();

반환 결과 :

  • WebSocket , 현재 객체 반환

on

이벤트 핸들러를 객체에 바인딩

1 2
Object WebSocket.on(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

이벤트 핸들러를 객체에 바인딩

1
Object WebSocket.on(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 객체 속성 이름은 이벤트 이름, 속성 값은 이벤트 처리 함수가됩니다.

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

addListener

이벤트 핸들러를 객체에 바인딩

1 2
Object WebSocket.addListener(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

이벤트 핸들러를 객체에 바인딩

1
Object WebSocket.addListener(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 객체 속성 이름은 이벤트 이름, 속성 값은 이벤트 처리 함수가됩니다.

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

prependListener

이벤트 처리기를 개체의 시작에 바인딩

1 2
Object WebSocket.prependListener(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

이벤트 처리기를 개체의 시작에 바인딩

1
Object WebSocket.prependListener(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 객체 속성 이름은 이벤트 이름, 속성 값은 이벤트 처리 함수가됩니다.

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

once

일회성 이벤트 처리 기능을 객체에 바인딩하면 일회성 처리 기능이 한 번만 트리거됩니다.

1 2
Object WebSocket.once(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

일회성 이벤트 처리 기능을 객체에 바인딩하면 일회성 처리 기능이 한 번만 트리거됩니다.

1
Object WebSocket.once(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 객체 속성 이름은 이벤트 이름, 속성 값은 이벤트 처리 함수가됩니다.

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

prependOnceListener

이벤트 처리기를 개체의 시작에 바인딩

1 2
Object WebSocket.prependOnceListener(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

이벤트 처리기를 개체의 시작에 바인딩

1
Object WebSocket.prependOnceListener(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 객체 속성 이름은 이벤트 이름, 속성 값은 이벤트 처리 함수가됩니다.

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

off

개체 처리 대기열에서 지정된 기능을 취소합니다.

1 2
Object WebSocket.off(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

개체 처리 대기열의 모든 기능 취소

1
Object WebSocket.off(String ev);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

개체 처리 대기열에서 지정된 기능을 취소합니다.

1
Object WebSocket.off(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 이벤트 이름으로 객체 속성 이름 사용, 이벤트 처리 기능으로 속성 값 사용

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

removeListener

개체 처리 대기열에서 지정된 기능을 취소합니다.

1 2
Object WebSocket.removeListener(String ev, Function func);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정
  • func : 기능, 이벤트 처리 기능 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

개체 처리 대기열의 모든 기능 취소

1
Object WebSocket.removeListener(String ev);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

개체 처리 대기열에서 지정된 기능을 취소합니다.

1
Object WebSocket.removeListener(Object map);

호출 매개 변수 :

  • map : Object, 이벤트 매핑 관계 지정, 이벤트 이름으로 객체 속성 이름 사용, 이벤트 처리 기능으로 속성 값 사용

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

removeAllListeners

객체 처리 대기열에서 모든 이벤트의 모든 리스너를 취소합니다. 이벤트가 지정된 경우 지정된 이벤트의 모든 리스너를 제거합니다.

1
Object WebSocket.removeAllListeners(Array evs = []);

호출 매개 변수 :

  • evs : 배열, 이벤트 이름 지정

반환 결과 :

  • Object , 이벤트 객체 자체를 반환하며 체인 호출이 쉽습니다.

setMaxListeners

호환성을 위해서만 리스너 수의 기본 제한

1
WebSocket.setMaxListeners(Integer n);

호출 매개 변수 :

  • n : 정수, 이벤트 수 지정

getMaxListeners

호환성을 위해서만 리스너 수의 기본 제한을 가져옵니다.

1
Integer WebSocket.getMaxListeners();

반환 결과 :

  • Integer 는 기본 제한 수를 반환합니다.

listeners

쿼리 객체의 지정된 이벤트에 대한 리스너 배열

1
Array WebSocket.listeners(String ev);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정

반환 결과 :

  • Array 는 지정된 이벤트에 대한 리스너 배열을 반환합니다.

listenerCount

쿼리 개체의 지정된 이벤트에 대한 리스너 수

1
Integer WebSocket.listenerCount(String ev);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름 지정

반환 결과 :

  • Integer 는 지정된 이벤트에 대한 리스너 수를 반환합니다.

eventNames

쿼리 리스너 이벤트 이름

1
Array WebSocket.eventNames();

반환 결과 :

  • Array 는 이벤트 이름의 배열을 반환합니다.

emit

이벤트를 적극적으로 트리거

1 2
Boolean WebSocket.emit(String ev, ...args);

호출 매개 변수 :

  • ev : 문자열, 이벤트 이름
  • args : ..., 이벤트 핸들러로 전달되는 이벤트 매개 변수

반환 결과 :

  • Boolean , 이벤트 트리거 상태를 반환하고, 응답 이벤트가 있으면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

toString

객체의 문자열 표현을 반환합니다. 일반적으로 "[Native Object]"를 반환합니다. 객체는 자체 특성에 따라 다시 구현 될 수 있습니다.

1
String WebSocket.toString();

반환 결과 :

  • String , 객체의 문자열 표현을 반환합니다.

toJSON

객체의 JSON 형식 표현을 반환하고 일반적으로 객체가 정의한 읽을 수있는 속성 모음을 반환합니다.

1
Value WebSocket.toJSON(String key = "");

호출 매개 변수 :

  • key : 문자열, 미사용

반환 결과 :

  • Value , 직렬화 가능한 JSON이 포함 된 값을 반환합니다.