nl::Weave::Profiles::Echo_Next::WeaveEchoClient

Provides the ability to send Weave EchoRequest messages to a peer node and receive
the corresponding EchoResponse messages.

요약

WeaveEchoClient 클래스는 Weave Echo 프로토콜의 시작자 측을 구현합니다. ICMP 핑 프로토콜과 마찬가지로 Weave Echo 프로토콜을 사용하여 Weave 노드의 활성 및 연결 가능성을 테스트할 수 있습니다.

애플리케이션은 WeaveEchoClient 클래스를 사용하여 Binding 객체로 식별된 피어 노드에 일회성 또는 반복 EchoRequest 메시지를 보낼 수 있습니다. 에코 요청에 응답하기 위한 상응하는 클래스가 존재합니다 (WeaveEchoServer 참조).

클라이언트 바인딩

WeaveEchoClient는 에코 요청의 의도된 수신자를 식별하고 통신하는 데 사용되는 Weave Binding 객체를 받습니다. Binding은 WeaveEchoClient 객체를 초기화하기 전에 애플리케이션에서 구성하고 준비하거나 준비되지 않은 상태로 둘 수 있습니다. 이 경우 WeaveEchoClient는 필요에 따라 바인딩 준비를 요청합니다 (자세한 내용은 Binding::RequestPrepare() 참조).

준비 상태로 전환된 후 실패하는 경우 바인딩의 주문형 준비도 요청됩니다.

반복 모드

SendRepeating() 메서드를 사용하여 WeaveEchoClient를 SendRepeating 모드로 전환할 수 있습니다. 이 모드에서 클라이언트 객체는 구성된 간격으로 반복된 일련의 EchoRequest 메시지를 피어에 전송합니다. SendRepeating 모드는 Stop() 메서드를 호출하여 취소할 수 있습니다.

멀티캐스트 및 브로드캐스트

WeaveEchoClient 객체는 적절한 IPv6 멀티캐스트 주소 또는 IPv4 로컬 네트워크 브로드캐스트 주소 (255.255.255.255)로 Binding 객체를 구성하여 EchoRequest를 여러 수신자에게 동시에 보내는 데 사용할 수 있습니다. WeaveEchoClient 객체는 멀티캐스트 또는 브로드캐스트 피어 주소를 감지하는 경우 EchoRequest의 전송 시 자동으로 MultiResponse 모드로 전환됩니다.

이 모드에서 객체는 동일한 교환에 도착하는 모든 수신 EchoResponse 메시지를 계속 수신 대기하고 전달합니다. 객체는 1) 애플리케이션이 Stop() 또는 Send()를 호출하거나, 2) SendRepeating 모드에서, 다른 요청을 전송할 시간이 되거나, 3) 응답이 수신되지 않고 수신 제한 시간이 만료될 때까지 다중 응답 모드로 유지됩니다.

API 이벤트

작업 중에 WeaveEchoClient 객체는 애플리케이션을 호출하여 특정 작업을 요청하거나 중요한 이벤트의 알림을 전달합니다. 이러한 API 이벤트 호출은 클라이언트 객체에 현재 구성된 콜백 함수에 대해 이루어집니다. 달리 명시되지 않는 한 애플리케이션은 이벤트 콜백 중에 클라이언트의 상태를 변경할 수 있습니다. 한 가지 전반적인 예외는 객체의 Shutdown() 메서드이며 콜백 도중에 호출되지 않을 수 있습니다.

다음과 같은 API 이벤트가 정의됩니다.

PreparePayload

WeaveEchoClient가 EchoRequest 메시지를 작성하려고 하고 페이로드를 제공하도록 애플리케이션에 요청합니다. 애플리케이션이 원하는 경우 페이로드 데이터를 포함하는 새로운 PacketBuffer를 반환할 수 있습니다. 애플리케이션이 이 이벤트를 처리하지 않는 경우, 길이가 0인 페이로드가 포함된 EchoRequest가 자동으로 전송됩니다. 애플리케이션은 이 콜백 중에 WeaveEchoClient의 상태를 변경하면 안 됩니다(MAY NOT).

RequestSent

EchoRequest 메시지가 피어에 전송되었습니다.

ResponseReceived

피어로부터 EchoResponse 메시지가 수신되었습니다. 이벤트에 대한 인수에는 응답 메시지에 대한 응답 페이로드와 메타 정보가 포함됩니다.

CommunicationError

EchoRequest를 작성하거나 전송하는 동안 또는 응답을 기다리는 동안 오류가 발생했습니다. 응답을 기다리는 동안 발생할 수 있는 오류의 예로는 키 오류 또는 예상치 못한 연결 종료 등이 있습니다. 이벤트 인수에는 오류 이유가 포함됩니다.

ResponseTimeout

할당된 시간 내에 EchoResponse가 수신되지 않았습니다. 응답 제한 시간은 Binding 객체의 DefaultResponseTimeout 속성으로 제어됩니다.

RequestAborted

이전 메시지에 대한 응답을 수신하기 전에 다른 EchoRequest를 전송하라는 요청이 발생했으므로 진행 중인 에코 교환이 취소되었습니다. SendRepeating 모드에서 다음 EchoRequest를 전송할 시간이 되면 발생할 수 있습니다. EchoRequest가 전송된 후 응답이 수신되기 전에 애플리케이션이 Send()를 호출하는 경우에도 이러한 상황이 발생할 수 있습니다.

객체가 MultiResponse 모드인 경우 EchoResponse 메시지가 하나 이상 수신되면 이벤트가 차단됩니다.

공개 유형

void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)

 EventType

 State

void * AppState

Binding * GetBinding(
  void
) const 

EventCallback GetEventCallback(
  void
) const 

State GetState(
  void
) const 

WEAVE_ERROR Init(
  Binding *binding,
  EventCallback eventCallback,
  void *appState
)

bool IsSendRrepeating() const 

bool RequestInProgress() const 

WEAVE_ERROR Send(
  void
)

WEAVE_ERROR Send(
  PacketBuffer *payloadBuf
)

WEAVE_ERROR SendRepeating(
  uint32_t sendIntervalMS
)

void SetEventCallback(
  EventCallback eventCallback
)

void Shutdown(
  void
)

void Stop(
  void
)

 WeaveEchoClient(
  void
)

void DefaultEventHandler(
  void *appState,
  EventType eventType,
  const InEventParam & inParam,
  OutEventParam & outParam
)