51b93a5417
When a timer expires, it can optionally return a new expiration value. Clearly, that value can't be zero, as that would make it expire immediately again. To simplify the interface, and make it easier to migrate to rtc::TimeDelta, change it from an optional value to an always-present value that - if zero - means that the expiration time should be unchanged. This is just an internal refactoring, and not part of any external interface. Bug: webrtc:15593 Change-Id: I6e7010d2dbe774ccb260e14fd6b9861c319e2411 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/325281 Commit-Queue: Victor Boivie <boivie@webrtc.org> Reviewed-by: Florent Castelli <orphis@webrtc.org> Cr-Commit-Position: refs/heads/main@{#41045}
70 lines
2.5 KiB
C++
70 lines
2.5 KiB
C++
/*
|
|
* Copyright (c) 2021 The WebRTC project authors. All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license
|
|
* that can be found in the LICENSE file in the root of the source
|
|
* tree. An additional intellectual property rights grant can be found
|
|
* in the file PATENTS. All contributing project authors may
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
*/
|
|
#ifndef NET_DCSCTP_SOCKET_HEARTBEAT_HANDLER_H_
|
|
#define NET_DCSCTP_SOCKET_HEARTBEAT_HANDLER_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include "absl/strings/string_view.h"
|
|
#include "net/dcsctp/packet/chunk/heartbeat_ack_chunk.h"
|
|
#include "net/dcsctp/packet/chunk/heartbeat_request_chunk.h"
|
|
#include "net/dcsctp/packet/sctp_packet.h"
|
|
#include "net/dcsctp/public/dcsctp_options.h"
|
|
#include "net/dcsctp/socket/context.h"
|
|
#include "net/dcsctp/timer/timer.h"
|
|
|
|
namespace dcsctp {
|
|
|
|
// HeartbeatHandler handles all logic around sending heartbeats and receiving
|
|
// the responses, as well as receiving incoming heartbeat requests.
|
|
//
|
|
// Heartbeats are sent on idle connections to ensure that the connection is
|
|
// still healthy and to measure the RTT. If a number of heartbeats time out,
|
|
// the connection will eventually be closed.
|
|
class HeartbeatHandler {
|
|
public:
|
|
HeartbeatHandler(absl::string_view log_prefix,
|
|
const DcSctpOptions& options,
|
|
Context* context,
|
|
TimerManager* timer_manager);
|
|
|
|
// Called when the heartbeat interval timer should be restarted. This is
|
|
// generally done every time data is sent, which makes the timer expire when
|
|
// the connection is idle.
|
|
void RestartTimer();
|
|
|
|
// Called on received HeartbeatRequestChunk chunks.
|
|
void HandleHeartbeatRequest(HeartbeatRequestChunk chunk);
|
|
|
|
// Called on received HeartbeatRequestChunk chunks.
|
|
void HandleHeartbeatAck(HeartbeatAckChunk chunk);
|
|
|
|
private:
|
|
DurationMs OnIntervalTimerExpiry();
|
|
DurationMs OnTimeoutTimerExpiry();
|
|
|
|
const absl::string_view log_prefix_;
|
|
Context* ctx_;
|
|
TimerManager* timer_manager_;
|
|
// The time for a connection to be idle before a heartbeat is sent.
|
|
const DurationMs interval_duration_;
|
|
// Adding RTT to the duration will add some jitter, which is good in
|
|
// production, but less good in unit tests, which is why it can be disabled.
|
|
const bool interval_duration_should_include_rtt_;
|
|
const std::unique_ptr<Timer> interval_timer_;
|
|
const std::unique_ptr<Timer> timeout_timer_;
|
|
};
|
|
} // namespace dcsctp
|
|
|
|
#endif // NET_DCSCTP_SOCKET_HEARTBEAT_HANDLER_H_
|