ModuleClient class

function close(): Promise<Disconnected>

반환

전송 연결을 닫고 클라이언트 리소스를 제거합니다.

참고: 이 메서드를 호출한 후에는 ModuleClient 개체를 다시 사용할 수 없습니다.

function close(closeCallback?: Callback<Disconnected>)

매개 변수

지정된 인증 방법 및 지정된 전송 형식을 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.

static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): ModuleClient

매개 변수

반환

지정된 전송 형식을 사용하여 지정된 연결 문자열에서 IoT Hub 디바이스 클라이언트를 만듭니다.

static function fromConnectionString(connStr: string, transportCtor: any): ModuleClient

매개 변수

반환

static function fromEnvironment(transportCtor: any): Promise<ModuleClient>

매개 변수

반환

환경의 구성 정보를 사용하여 IoT Hub 모듈 클라이언트를 만듭니다.

EdgeHubConnectionString 또는 IotHubConnectionString 라는 환경 변수가 있는 경우 해당 값이 사용되며 동작은 해당 값을 전달하는 fromConnectionString 호출하는 것과 동일합니다. 이러한 환경 변수가 없으면 다음 변수를 정의해야 합니다.

- IOTEDGE_WORKLOADURI          URI for iotedged's workload API
- IOTEDGE_DEVICEID             Device identifier
- IOTEDGE_MODULEID             Module identifier
- IOTEDGE_MODULEGENERATIONID   Module generation identifier
- IOTEDGE_IOTHUBHOSTNAME       IoT Hub host name
- IOTEDGE_AUTHSCHEME           Authentication scheme to use; must be "sasToken"

static function fromEnvironment(transportCtor: any, callback?: Callback<ModuleClient>)

매개 변수

지정된 전송 형식을 사용하여 지정된 공유 액세스 서명에서 IoT Hub 모듈 클라이언트를 만듭니다.

static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): ModuleClient

매개 변수

반환

function invokeMethod(deviceId: string, methodParams: MethodParams): Promise<MethodResult>

매개 변수

반환

다운스트림 디바이스 또는 동일한 IoTEdge 디바이스의 다른 모듈에서 메서드를 호출합니다. 이 기능은 모듈이 IoTEdge 디바이스의 일부로 실행되는 경우에만 작동합니다.

function invokeMethod(deviceId: string, methodParams: MethodParams, callback?: Callback<MethodResult>)

매개 변수

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams): Promise<MethodResult>

매개 변수

반환

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams, callback: Callback<MethodResult>)

매개 변수

methodName메서드에 대한 콜백을 등록합니다.

function onMethod(methodName: string, callback: DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

매개 변수

function sendOutputEvent(outputName: string, message: Message): Promise<MessageEnqueued>

매개 변수

반환

지정된 모듈 출력에 이벤트를 보냅니다.

function sendOutputEvent(outputName: string, message: Message, callback?: Callback<MessageEnqueued>)

매개 변수

function sendOutputEventBatch(outputName: string, messages: Message[]): Promise<MessageEnqueued>

매개 변수

반환

지정된 모듈 출력에 이벤트 배열을 보냅니다.

function sendOutputEventBatch(outputName: string, messages: Message[], callback?: Callback<MessageEnqueued>)

매개 변수

function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>

매개 변수

반환

전송을 구성하는 데 사용할 수 있는 ModuleClient 개체에 옵션을 전달합니다.

function setOptions(options: DeviceClientOptions, done?: Callback<TransportConfigured>)

매개 변수

function abandon(message: Message): Promise<MessageAbandoned>

매개 변수

반환

InternalClient.abandon에서 상속된

function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)

매개 변수

InternalClient.abandon에서 상속된

에 대한 별칭입니다 emitter.on(eventName, listener).

function addListener<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.addListener에서 상속된

function complete(message: Message): Promise<MessageCompleted>

매개 변수

반환

InternalClient.complete에서 상속된

function complete(message: Message, completeCallback: Callback<MessageCompleted>)

매개 변수

InternalClient.complete에서 상속된

등록된 순서대로 eventName이벤트에 등록된 각 수신기를 동기적으로 호출하여 제공된 인수를 각각에 전달합니다.

이벤트에 수신기가 있으면 true 반환하고, 그렇지 않으면 false.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

function emit<E>(eventName: string | symbol, args: any[]): boolean

매개 변수

반환

InternalClient.emit에서 상속된

이미터가 수신기를 등록한 이벤트를 나열하는 배열을 반환합니다.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

function eventNames(): (string | symbol)[]

반환

InternalClient.eventNames에서 상속된

EventEmitter 설정되거나 emitter.setMaxListeners(n)기본값인 events.defaultMaxListeners 대한 현재 최대 수신기 값을 반환합니다.

function getMaxListeners(): number

반환

InternalClient.getMaxListeners에서 상속된

function getTwin(): Promise<Twin>

반환

InternalClient.getTwin에서 상속된

function getTwin(done: Callback<Twin>)

매개 변수

InternalClient.getTwin에서 상속된

eventName이벤트를 수신 대기하는 수신기 수를 반환합니다. listener 제공된 경우 수신기가 이벤트 수신기 목록에서 발견된 횟수를 반환합니다.

function listenerCount<E>(eventName: string | symbol, listener?: (args: any[]) => void): number

매개 변수

반환

InternalClient.listenerCount에서 상속된

eventName이벤트에 대한 수신기 배열의 복사본을 반환합니다.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

function listeners<E>(eventName: string | symbol): (args: any[]) => void[]

매개 변수

반환

InternalClient.listeners에서 상속된

에 대한 별칭입니다 emitter.removeListener().

function off<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.off에서 상속된

listener이벤트에 대한 수신기 배열의 끝에 eventName 함수를 추가합니다. listener 이미 추가되었는지 확인하기 위한 검사는 수행되지 않습니다. eventName 및 listener 동일한 조합을 전달하는 여러 호출은 listener 여러 번 추가되고 호출됩니다.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

기본적으로 이벤트 수신기는 추가되는 순서대로 호출됩니다. emitter.prependListener() 메서드를 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function on<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.on에서 상속된

이벤트에 대한 listenereventName 함수를 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

기본적으로 이벤트 수신기는 추가되는 순서대로 호출됩니다. emitter.prependOnceListener() 메서드를 수신기 배열의 시작 부분에 이벤트 수신기를 추가하는 대안으로 사용할 수 있습니다.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function once<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.once에서 상속된

function open(): Promise<Connected>

반환

InternalClient.open에서 상속된

function open(openCallback: Callback<Connected>)

매개 변수

InternalClient.open에서 상속된

이벤트에 대한 수신기 배열의 시작 함수를 추가합니다. listener 이미 추가되었는지 확인하기 위한 검사는 수행되지 않습니다. eventName 및 listener 동일한 조합을 전달하는 여러 호출은 listener 여러 번 추가되고 호출됩니다.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

function prependListener<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.prependListener에서 상속된

수신기 배열의 시작 이벤트에 대한 일회성 함수를 추가합니다. 다음에 eventName 트리거되면 이 수신기가 제거된 다음 호출됩니다.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

function prependOnceListener<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.prependOnceListener에서 상속된

래퍼(예: eventName만든 래퍼)를 포함하여 .once()이벤트에 대한 수신기 배열의 복사본을 반환합니다.

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

function rawListeners<E>(eventName: string | symbol): (args: any[]) => void[]

매개 변수

반환

InternalClient.rawListeners에서 상속된

function reject(message: Message): Promise<MessageRejected>

매개 변수

반환

InternalClient.reject에서 상속된

function reject(message: Message, rejectCallback: Callback<MessageRejected>)

매개 변수

InternalClient.reject에서 상속된

모든 수신기 또는 지정된 eventName제거합니다.

특히 다른 구성 요소 또는 모듈(예: 소켓 또는 파일 스트림)에서 EventEmitter 인스턴스를 만든 경우 코드의 다른 위치에 추가된 수신기를 제거하는 것은 잘못된 방법입니다.

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

function removeAllListeners<E>(eventName?: string | symbol): ModuleClient

매개 변수

반환

InternalClient.removeAllListeners에서 상속된

listener이벤트에 대한 수신기 배열에서 지정된 eventName 제거합니다.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() 수신기 배열에서 수신기의 인스턴스를 하나 이상 제거합니다. 단일 수신기가 지정된 eventName대한 수신기 배열에 여러 번 추가된 경우 각 인스턴스를 제거하려면 removeListener() 여러 번 호출해야 합니다.

이벤트가 내보내지면 내보내기 시 연결된 모든 수신기가 순서대로 호출됩니다. 이는 방출 removeListener() 마지막 리스너가 실행을 마치removeAllListeners() 호출이 진행 중인 상태에서 제거 되지 않는다는 것을 emit() 의미합니다. 후속 이벤트는 예상대로 동작합니다.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

리스너는 내부 배열로 관리되기 때문에, 이를 호출하면 리스너가 제거 된 후 등록된 리스너의 위치 인덱스가 변경됩니다. 이는 수신기가 호출되는 순서에 영향을 주지 않지만 emitter.listeners() 메서드에서 반환된 수신기 배열의 복사본을 다시 만들어야 한다는 것을 의미합니다.

단일 함수가 단일 이벤트에 대해 처리기로 여러 번 추가된 경우(아래 예제와 같이) removeListener() 가장 최근에 추가된 인스턴스를 제거합니다. 예제에서 once('ping') 수신기가 제거됩니다.

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

function removeListener<E>(eventName: string | symbol, listener: (args: any[]) => void): ModuleClient

매개 변수

반환

InternalClient.removeListener에서 상속된

function sendEvent(message: Message): Promise<MessageEnqueued>

매개 변수

반환

InternalClient.sendEvent에서 상속된

function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)

매개 변수

InternalClient.sendEvent에서 상속된

function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>

매개 변수

반환

InternalClient.sendEventBatch에서 상속된

function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)

매개 변수

InternalClient.sendEventBatch에서 상속된

기본적으로 EventEmitter특정 이벤트에 대해 10 개 이상의 수신기가 추가되면 경고를 출력합니다. 이는 메모리 누수 찾기에 도움이 되는 유용한 기본값입니다. emitter.setMaxListeners() 메서드를 사용하면 이 특정 EventEmitter 인스턴스에 대한 제한을 수정할 수 있습니다. 값을 Infinity(또는 0)로 설정하여 무제한 수신기를 나타낼 수 있습니다.

호출을 연결할 수 있도록 EventEmitter대한 참조를 반환합니다.

function setMaxListeners(n: number): ModuleClient

매개 변수

반환

InternalClient.setMaxListeners에서 상속된

모든 작업에서 클라이언트가 사용하는 재시도 정책을 설정합니다. 기본값은 ExponentialBackoffWithJitter.

function setRetryPolicy(policy: RetryPolicy)

매개 변수

InternalClient.setRetryPolicy에서 상속된

function setTransportOptions(options: any): Promise<TransportConfigured>

매개 변수

반환

InternalClient.setTransportOptions에서 상속된

function setTransportOptions(options: any, done: Callback<TransportConfigured>)

매개 변수

InternalClient.setTransportOptions에서 상속된

function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)

매개 변수

InternalClient.updateSharedAccessSignature에서 상속된

Symbol.for('nodejs.rejection') 이 메서드는 이벤트를 방출할 때 약속 거부가 발생할 때 호출되며, captureRejections 이미터에서 활성화됩니다. 를 대신events.captureRejectionSymbol해 사용할 Symbol.for('nodejs.rejection') 수 있습니다.

import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

function [captureRejectionSymbol](error: Error, event: string | symbol, args: any[])

매개 변수

상속된 곳 InternalClient.__@captureRejectionSymbol@129