Client class

new Client(transport: DeviceTransport, connStr?: string, blobUploadClient?: BlobUploadClient, fileUploadApi?: FileUploadInterface)

パラメーター

function close(): Promise<Disconnected>

戻り値

トランスポート接続を閉じ、クライアント リソースを破棄します。

注: このメソッドを呼び出した後、Client オブジェクトを再利用することはできません。

function close(closeCallback?: Callback<Disconnected>)

パラメーター

指定された認証方法から、指定されたトランスポートの種類を使用して、IoT Hub デバイス クライアントを作成します。

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

パラメーター

戻り値

指定したトランスポートの種類を使用して、指定された接続文字列から IoT Hub デバイス クライアントを作成します。

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

パラメーター

戻り値

指定したトランスポートの種類を使用して、指定された共有アクセス署名から IoT Hub デバイス クライアントを作成します。

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

パラメーター

戻り値

function getBlobSharedAccessSignature(blobName: string): Promise<UploadParams>

パラメーター

戻り値

getBlobSharedAccessSignature は、IoT Hub からリンクされたストレージ アカウント SAS トークンを取得します

function getBlobSharedAccessSignature(blobName: string, callback?: Callback<UploadParams>)

パラメーター

function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string): Promise<void>

パラメーター

戻り値

notifyBlobUploadStatus メソッドは、BLOB アップロードの結果を IoT Hub に送信します。

function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string, callback?: ErrorCallback)

パラメーター

methodNameという名前のメソッドのコールバックを登録します。

function onDeviceMethod(methodName: string, callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)

パラメーター

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

パラメーター

戻り値

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

パラメーター

function uploadToBlob(blobName: string, stream: Stream, streamLength: number): Promise<void>

パラメーター

戻り値

uploadToBlob メソッドは、BLOB にストリームをアップロードします。

function uploadToBlob(blobName: string, stream: Stream, streamLength: number, callback: ErrorCallback)

パラメーター

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): Client

パラメーター

戻り値

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): Client

パラメーター

戻り値

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): Client

パラメーター

戻り値

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): Client

パラメーター

戻り値

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): Client

パラメーター

戻り値

internalClient.prependListener から継承

という名前のイベントの 1 回限りの 関数をリスナー配列の先頭 に追加します。 次に eventName がトリガーされると、このリスナーが削除され、呼び出されます。

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

呼び出しをチェーンできるように、EventEmitterへの参照を返します。

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

パラメーター

戻り値

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): Client

パラメーター

戻り値

internalClient.removeAllListeners から継承

listenerという名前のイベントのリスナー配列から、指定した eventName を削除します。

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

removeListener() は、リスナー配列からリスナーのインスタンスを最大で 1 つ削除します。 指定した eventNameのリスナー配列に 1 つのリスナーが複数回追加されている場合は、各インスタンスを削除するために 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() メソッドによって返されるリスナー配列のコピーを再作成する必要があることを意味します。

(次の例のように) 1 つのイベントに対して 1 つの関数がハンドラーとして複数回追加された場合、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): Client

パラメーター

戻り値

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 から継承された

既定では、EventEmitters は、特定のイベントに対して 10 を超えるリスナーが追加された場合に警告を出力します。 これは、メモリ リークの検出に役立つ便利な既定値です。 emitter.setMaxListeners() メソッドを使用すると、この特定の EventEmitter インスタンスの制限を変更できます。 この値を Infinity (または 0) に設定すると、リスナーの数に制限はありません。

呼び出しをチェーンできるように、EventEmitterへの参照を返します。

function setMaxListeners(n: number): Client

パラメーター

戻り値

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が有効化された場合に呼び出されます。 Symbol.for('nodejs.rejection')の代わりに events.captureRejectionSymbol を使うことも可能です。

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@127