NodeWebSocket class

패키지:

botframework-streaming

NodeWebSocketFactory 사용하여 WebSocket 서버를 만드는 데 사용할 ISocket 구현입니다.

생성자

NodeWebSocket(WebSocket)

새 NodeWebSocket 인스턴스를 만듭니다.

속성

isConnected

'ws' WebSocket이 현재 연결되어 있고 메시지를 보낼 준비가 되었는지를 나타냅니다.

메서드

close(number, string)	소켓을 닫습니다.
connect(string, number)	WebSocket 프로토콜을 사용하여 지원 소켓에 연결합니다.
create(INodeIncomingMessage, INodeSocket, INodeBuffer)	HTTP 요청, 소켓 및 버퍼를 사용하여 ws WebSocket을 만들고 설정합니다.
setOnCloseHandler((x: any) => void)	소켓 닫기를 발견할 때 호출할 콜백을 설정합니다.
setOnErrorHandler((x: any) => void)	오류가 발생할 때 호출할 콜백을 설정합니다.
setOnMessageHandler((x: any) => void)	소켓에서 수신된 'data' 및 'message' 이벤트에 대한 처리기를 설정합니다.
write(INodeBuffer)	버퍼를 소켓에 쓰고 보냅니다.

생성자 세부 정보

NodeWebSocket(WebSocket)

새 NodeWebSocket 인스턴스를 만듭니다.

new NodeWebSocket(wsSocket?: WebSocket)

매개 변수

wsSocket

WebSocket

이 연결을 빌드할 ws WebSocket 인스턴스입니다.

속성 세부 정보

isConnected

'ws' WebSocket이 현재 연결되어 있고 메시지를 보낼 준비가 되었는지를 나타냅니다.

boolean isConnected

속성 값

boolean

true 기본 websocket이 준비되고 메시지를 보낼 수 있으면 false.

메서드 세부 정보

close(number, string)

소켓을 닫습니다.

function close(code?: number, data?: string)

매개 변수

code

number

연결이 닫힌 이유를 설명하는 선택적 상태 코드입니다.

data

string

연결이 닫힌 이유를 설명하는 선택적 추가 데이터입니다.

설명

필요에 따라 연결이 닫히는 이유를 설명하는 상태 코드와 문자열을 전달합니다.

connect(string, number)

WebSocket 프로토콜을 사용하여 지원 소켓에 연결합니다.

function connect(serverAddress: string, port?: number): Promise<void>

매개 변수

serverAddress

string

서버가 수신 대기 중인 주소입니다.

port

number

서버가 수신 대기 중인 포트는 기본적으로 8082입니다.

반환

Promise<void>

websocket 연결이 닫혔을 때 확인되거나 오류 발생 시 거부되는 Promise입니다.

create(INodeIncomingMessage, INodeSocket, INodeBuffer)

HTTP 요청, 소켓 및 버퍼를 사용하여 ws WebSocket을 만들고 설정합니다.

function create(req: INodeIncomingMessage, socket: INodeSocket, head: INodeBuffer): Promise<void>

매개 변수

req

INodeIncomingMessage

INodeIncomingMessage 인터페이스와 일치하는 HTTP 요청입니다.

socket

INodeSocket

소켓 INodeSocket 인터페이스입니다.

head

INodeBuffer

버퍼 INodeBuffer 인터페이스입니다.

반환

Promise<void>

WebSocket 업그레이드가 처리된 후 해결되는 Promise입니다. 그렇지 않으면 throw된 오류로 거부됩니다.

setOnCloseHandler((x: any) => void)

소켓 닫기를 발견할 때 호출할 콜백을 설정합니다.

function setOnCloseHandler(handler: (x: any) => void)

매개 변수

handler

(x: any) => void

"close" 이벤트를 처리할 콜백입니다.

setOnErrorHandler((x: any) => void)

오류가 발생할 때 호출할 콜백을 설정합니다.

function setOnErrorHandler(handler: (x: any) => void)

매개 변수

handler

(x: any) => void

"error" 이벤트를 처리할 콜백입니다.

setOnMessageHandler((x: any) => void)

소켓에서 수신된 'data' 및 'message' 이벤트에 대한 처리기를 설정합니다.

function setOnMessageHandler(handler: (x: any) => void)

매개 변수

handler

(x: any) => void

"메시지" 이벤트를 처리할 콜백입니다.

write(INodeBuffer)

버퍼를 소켓에 쓰고 보냅니다.

function write(buffer: INodeBuffer)

매개 변수

buffer

INodeBuffer

연결을 통해 보낼 데이터의 버퍼입니다.