객체 내장 객체

개체 WebSocketMessage

웹 소켓 메시지 객체

생성 방법:

1 2 3
var ws = require("ws"); var msg = new ws.Message();

계승

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>Message|new Message()|TEXT;BINARY|value;params;type;data;body;length;stream;lastError|read();readAll();write();json();pack();end();isEnded();clear();sendTo();readFrom()] [<this>WebSocketMessage|new WebSocketMessage()|masked;compress;maxSize] [object] <:- [Message] [Message] <:- [WebSocketMessage] Message new Message() TEXT BINARY value params type data body length stream lastError read() readAll() write() json() pack() end() isEnded() clear() sendTo() readFrom() WebSocketMessage new WebSocketMessage() masked compress maxSize object toString() toJSON()

건설자

WebSocketMessage

패키지 처리 메시지 객체 생성자

1 2 3 4
new WebSocketMessage(Integer type = ws.BINARY, Boolean masked = true, Boolean compress = false, Integer maxSize = 67108864);

호출 매개변수:

  • type: 정수, websocket 메시지 유형, 기본값은 websocket.BINARY입니다.
  • masked: Boolean, websocket 메시지 마스크, 기본값은 true
  • compress: Boolean, 메시지 압축 여부 표시, 기본값은 false
  • maxSize: 정수, 최대 패키지 크기(MB), 기본값은 67108864(64M)입니다.

일정한

TEXT

텍스트 유형을 나타내는 메시지 유형 1을 지정하십시오.

1
const WebSocketMessage.TEXT = 1;

BINARY

이진 유형을 나타내는 메시지 유형 2를 지정하십시오.

1
const WebSocketMessage.BINARY = 2;

회원 속성

masked

부울, 쿼리 및 웹 소켓 마스크 표시 읽기, 기본값은 true입니다.

1
Boolean WebSocketMessage.masked;

compress

부울, 쿼리 및 웹 소켓 압축 상태 읽기, 기본값은 false

1
Boolean WebSocketMessage.compress;

maxSize

정수, 쿼리 및 최대 패킷 크기(바이트 단위) 설정, 기본값은 67108864(64M)입니다.

1
Integer WebSocketMessage.maxSize;

value

문자열, 메시지의 기본 내용

1
String WebSocketMessage.value;

params

NArray, 메시지의 기본 매개변수

1
readonly NArray WebSocketMessage.params;

type

정수, 메시지 유형

1
Integer WebSocketMessage.type;

data

값, 메시지 데이터 쿼리, 이 속성은 콘텐츠 유형에 따라 다른 데이터를 반환하고, 텍스트인 경우 텍스트를 반환합니다. json 돌아올 때 json, 다른 시간은 바이너리로 반환

1
readonly Value WebSocketMessage.data;

body

SeekableStream, 메시지의 데이터 부분을 포함하는 스트림 객체

1
SeekableStream WebSocketMessage.body;

length

Long, 메시지의 데이터 부분의 길이

1
readonly Long WebSocketMessage.length;

stream

Stream, 메시지가 읽을 때 스트림 개체를 쿼리합니다.

1
readonly Stream WebSocketMessage.stream;

lastError

문자열, 쿼리 및 메시지 처리의 마지막 오류 설정

1
String WebSocketMessage.lastError;

멤버 함수

read

스트림에서 지정된 크기의 데이터를 읽습니다. 이 메서드는 해당하는 body 메서드의 별칭입니다.

1
Buffer WebSocketMessage.read(Integer bytes = -1) async;

호출 매개변수:

  • bytes: 정수, 읽을 데이터의 양을 지정합니다. 기본값은 임의 크기의 데이터 블록을 읽는 것입니다. 읽은 데이터의 크기는 장치에 따라 다릅니다.

반환 결과:

  • Buffer, 스트림에서 읽은 데이터를 반환합니다. 읽을 데이터가 없거나 연결이 중단되면 null을 반환합니다.

readAll

스트림에서 나머지 데이터를 모두 읽습니다. 이 메서드는 해당하는 body 메서드의 별칭입니다.

1
Buffer WebSocketMessage.readAll() async;

반환 결과:

  • Buffer, 스트림에서 읽은 데이터를 반환합니다. 읽을 데이터가 없거나 연결이 중단되면 null을 반환합니다.

write

주어진 데이터를 쓰십시오. 이 메소드는 본문의 해당 메소드의 별칭입니다.

1
WebSocketMessage.write(Buffer data) async;

호출 매개변수:

  • data: Buffer, 쓸 데이터가 주어지면

json

JSON 인코딩으로 주어진 데이터 쓰기

1
Value WebSocketMessage.json(Value data);

호출 매개변수:

  • data: 쓸 데이터가 주어진 값

반환 결과:

  • Value, 이 메서드는 데이터를 반환하지 않습니다

JSON 인코딩으로 메시지의 데이터 구문 분석

1
Value WebSocketMessage.json();

반환 결과:

  • Value, 파싱된 결과를 반환

pack

~에 의해 msgpack 주어진 데이터를 쓰기 위한 인코딩

1
Value WebSocketMessage.pack(Value data);

호출 매개변수:

  • data: 쓸 데이터가 주어진 값

반환 결과:

  • Value, 이 메서드는 데이터를 반환하지 않습니다

~에 의해 msgpack 메시지의 데이터 인코딩 및 구문 분석

1
Value WebSocketMessage.pack();

반환 결과:

  • Value, 파싱된 결과를 반환

end

현재 메시지 처리의 끝을 설정하고,Chain 프로세서는 후속 트랜잭션을 계속하지 않습니다.

1
WebSocketMessage.end();

isEnded

현재 메시지가 끝났는지 쿼리

1
Boolean WebSocketMessage.isEnded();

반환 결과:

  • Boolean, 마지막에 true 반환

clear

메시지 내용 지우기

1
WebSocketMessage.clear();

sendTo

지정된 스트림 개체에 형식이 지정된 메시지 보내기

1
WebSocketMessage.sendTo(Stream stm) async;

호출 매개변수:

  • stm: Stream, 형식화된 메시지를 수신할 스트림 개체를 지정합니다.

readFrom

주어진 캐시 스트림 개체에서 형식이 지정된 메시지를 읽고 채우는 개체를 구문 분석합니다.

1
WebSocketMessage.readFrom(Stream stm) async;

호출 매개변수:

  • stm: Stream, 형식화된 메시지를 읽기 위한 스트림 개체 지정

toString

개체의 문자열 표현을 반환하고 일반적으로 "[네이티브 개체]"를 반환하며 개체는 고유한 특성에 따라 다시 구현할 수 있습니다.

1
String WebSocketMessage.toString();

반환 결과:

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

toJSON

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

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

호출 매개변수:

  • key: 문자열, 미사용

반환 결과:

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