nl::Weave::프로필::Echo_Next::WeaveEchoClient

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

요약

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

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

클라이언트 결합

WeaveEchoClient는 에코 요청을 의도된 수신자와 식별하고 설정하는 데 사용되는 Weave Binding 객체를 사용합니다. Bindinga는 WeaveEchoClient 객체를 초기화하기 전에 애플리케이션에서 구성 및 준비할 수 있습니다. 또는 준비되지 않은 상태로 둘 수도 있습니다. 이 경우 WeaveEchoClient는 주문형 바인딩 준비를 요청합니다 (자세한 내용은 Binding::RequestPrepare() 참고).

또한 준비 상태가 되면 Binding이 요청 시 준비되도록 합니다.

SendRepeating 모드

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

멀티캐스트 및 방송

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

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

API 이벤트

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

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

준비 페이로드

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

RequestSent

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

응답 수신됨

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

통신 오류

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

응답 시간 초과

주어진 기간 동안 EchoResponse가 수신되지 않았습니다. 응답 시간 제한은 결합 객체의 DefaultResponseTimeout 속성에서 제어합니다.

요청 취소됨

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

객체가 다중 응답 모드일 때는 하나 이상의 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
)