diff --git a/internal/mocks/connection_tracer.go b/internal/mocks/connection_tracer.go index a5fd0cf4..b8ad6477 100644 --- a/internal/mocks/connection_tracer.go +++ b/internal/mocks/connection_tracer.go @@ -64,7 +64,7 @@ func (mr *MockConnectionTracerMockRecorder) Close() *gomock.Call { } // ClosedConnection mocks base method -func (m *MockConnectionTracer) ClosedConnection(arg0 logging.CloseReason) { +func (m *MockConnectionTracer) ClosedConnection(arg0 logging.TimeoutReason) { m.ctrl.T.Helper() m.ctrl.Call(m, "ClosedConnection", arg0) } diff --git a/logging/interface.go b/logging/interface.go index cdde3a34..1129c7f6 100644 --- a/logging/interface.go +++ b/logging/interface.go @@ -8,6 +8,7 @@ import ( "github.com/lucas-clemente/quic-go/internal/congestion" "github.com/lucas-clemente/quic-go/internal/protocol" + "github.com/lucas-clemente/quic-go/internal/qerr" "github.com/lucas-clemente/quic-go/internal/wire" ) @@ -32,6 +33,7 @@ type ( StreamType = protocol.StreamType // The VersionNumber is the QUIC version. VersionNumber = protocol.VersionNumber + // The Header is the QUIC packet header, before removing header protection. Header = wire.Header // The ExtendedHeader is the QUIC packet header, after removing header protection. @@ -39,6 +41,11 @@ type ( // The TransportParameters are QUIC transport parameters. TransportParameters = wire.TransportParameters + // A TransportError is a transport-level error code. + TransportError = qerr.ErrorCode + // An ApplicationError is an application-defined error code. + ApplicationError = qerr.ErrorCode + // The RTTStats contain statistics used by the congestion controller. RTTStats = congestion.RTTStats ) @@ -77,7 +84,7 @@ type Tracer interface { // A ConnectionTracer records events. type ConnectionTracer interface { StartedConnection(local, remote net.Addr, version VersionNumber, srcConnID, destConnID ConnectionID) - ClosedConnection(CloseReason) + ClosedConnection(TimeoutReason) SentTransportParameters(*TransportParameters) ReceivedTransportParameters(*TransportParameters) SentPacket(hdr *ExtendedHeader, packetSize ByteCount, ack *AckFrame, frames []Frame) diff --git a/logging/types.go b/logging/types.go index 0520e888..3e0bfb4b 100644 --- a/logging/types.go +++ b/logging/types.go @@ -70,14 +70,14 @@ const ( TimerTypePTO ) -// CloseReason is the reason why a session is closed -type CloseReason uint8 +// TimeoutReason is the reason why a session is closed +type TimeoutReason uint8 const ( - // CloseReasonHandshakeTimeout is used when the session is closed due to a handshake timeout + // TimeoutReasonHandshake is used when the session is closed due to a handshake timeout // This reason is not defined in the qlog draft, but very useful for debugging. - CloseReasonHandshakeTimeout CloseReason = iota - // CloseReasonIdleTimeout is used when the session is closed due to an idle timeout + TimeoutReasonHandshake TimeoutReason = iota + // TimeoutReasonIdle is used when the session is closed due to an idle timeout // This reason is not defined in the qlog draft, but very useful for debugging. - CloseReasonIdleTimeout + TimeoutReasonIdle ) diff --git a/qlog/event.go b/qlog/event.go index 38676c33..49267da4 100644 --- a/qlog/event.go +++ b/qlog/event.go @@ -94,7 +94,7 @@ func (e eventConnectionStarted) MarshalJSONObject(enc *gojay.Encoder) { } type eventConnectionClosed struct { - Reason closeReason + Reason timeoutReason } func (e eventConnectionClosed) Category() category { return categoryTransport } diff --git a/qlog/qlog.go b/qlog/qlog.go index e0fb0d48..a2a6f171 100644 --- a/qlog/qlog.go +++ b/qlog/qlog.go @@ -163,9 +163,9 @@ func (t *connectionTracer) StartedConnection(local, remote net.Addr, version pro t.mutex.Unlock() } -func (t *connectionTracer) ClosedConnection(r logging.CloseReason) { +func (t *connectionTracer) ClosedConnection(r logging.TimeoutReason) { t.mutex.Lock() - t.recordEvent(time.Now(), &eventConnectionClosed{Reason: closeReason(r)}) + t.recordEvent(time.Now(), &eventConnectionClosed{Reason: timeoutReason(r)}) t.mutex.Unlock() } diff --git a/qlog/qlog_test.go b/qlog/qlog_test.go index 9893162e..67003f5f 100644 --- a/qlog/qlog_test.go +++ b/qlog/qlog_test.go @@ -172,7 +172,7 @@ var _ = Describe("Tracing", func() { }) It("records connection closes", func() { - tracer.ClosedConnection(logging.CloseReasonIdleTimeout) + tracer.ClosedConnection(logging.TimeoutReasonIdle) entry := exportAndParseSingle() Expect(entry.Time).To(BeTemporally("~", time.Now(), scaleDuration(10*time.Millisecond))) Expect(entry.Category).To(Equal("transport")) diff --git a/qlog/types.go b/qlog/types.go index 767e7806..e38d7724 100644 --- a/qlog/types.go +++ b/qlog/types.go @@ -296,13 +296,13 @@ func (t timerType) String() string { } } -type closeReason logging.CloseReason +type timeoutReason logging.TimeoutReason -func (r closeReason) String() string { - switch logging.CloseReason(r) { - case logging.CloseReasonHandshakeTimeout: +func (r timeoutReason) String() string { + switch logging.TimeoutReason(r) { + case logging.TimeoutReasonHandshake: return "handshake_timeout" - case logging.CloseReasonIdleTimeout: + case logging.TimeoutReasonIdle: return "idle_timeout" default: panic("unknown close reason") diff --git a/qlog/types_test.go b/qlog/types_test.go index 92a0258d..46ccf35f 100644 --- a/qlog/types_test.go +++ b/qlog/types_test.go @@ -59,8 +59,8 @@ var _ = Describe("Types", func() { }) It("has a string representation for the close reason", func() { - Expect(closeReason(logging.CloseReasonHandshakeTimeout).String()).To(Equal("handshake_timeout")) - Expect(closeReason(logging.CloseReasonIdleTimeout).String()).To(Equal("idle_timeout")) + Expect(timeoutReason(logging.TimeoutReasonHandshake).String()).To(Equal("handshake_timeout")) + Expect(timeoutReason(logging.TimeoutReasonIdle).String()).To(Equal("idle_timeout")) }) It("has a string representation for the key type", func() { diff --git a/session.go b/session.go index 184bd63b..fc6c556d 100644 --- a/session.go +++ b/session.go @@ -593,13 +593,13 @@ runLoop: s.keepAlivePingSent = true } else if !s.handshakeComplete && now.Sub(s.sessionCreationTime) >= s.config.HandshakeTimeout { if s.tracer != nil { - s.tracer.ClosedConnection(logging.CloseReasonHandshakeTimeout) + s.tracer.ClosedConnection(logging.TimeoutReasonHandshake) } s.destroyImpl(qerr.NewTimeoutError("Handshake did not complete in time")) continue } else if s.handshakeComplete && now.Sub(s.idleTimeoutStartTime()) >= s.idleTimeout { if s.tracer != nil { - s.tracer.ClosedConnection(logging.CloseReasonIdleTimeout) + s.tracer.ClosedConnection(logging.TimeoutReasonIdle) } s.destroyImpl(qerr.NewTimeoutError("No recent network activity")) continue diff --git a/session_test.go b/session_test.go index 4b7983f4..c411a2bc 100644 --- a/session_test.go +++ b/session_test.go @@ -1817,7 +1817,7 @@ var _ = Describe("Session", func() { done := make(chan struct{}) cryptoSetup.EXPECT().Close() gomock.InOrder( - tracer.EXPECT().ClosedConnection(logging.CloseReasonIdleTimeout), + tracer.EXPECT().ClosedConnection(logging.TimeoutReasonIdle), tracer.EXPECT().Close(), ) go func() { @@ -1839,7 +1839,7 @@ var _ = Describe("Session", func() { sessionRunner.EXPECT().Remove(gomock.Any()).Times(2) cryptoSetup.EXPECT().Close() gomock.InOrder( - tracer.EXPECT().ClosedConnection(logging.CloseReasonHandshakeTimeout), + tracer.EXPECT().ClosedConnection(logging.TimeoutReasonHandshake), tracer.EXPECT().Close(), ) done := make(chan struct{}) @@ -1889,7 +1889,7 @@ var _ = Describe("Session", func() { ) cryptoSetup.EXPECT().Close() gomock.InOrder( - tracer.EXPECT().ClosedConnection(logging.CloseReasonIdleTimeout), + tracer.EXPECT().ClosedConnection(logging.TimeoutReasonIdle), tracer.EXPECT().Close(), ) sess.idleTimeout = 0