gbn + mailbox: modify TimeoutManager through conf

This commit changes the gbn `Config` struct to not specifically contain
any timeout fields, but instead contain functional options that modifies
the `TimeoutManager` struct. These options are then applied to the
`TimeoutManager`.

Author: ViktorTigerstrom

gbn/config.go

@@ -44,22 +44,22 @@ func WithTimeoutUpdateFrequency(frequency int) TimeoutOptions {
 	}
 }
 
-// WithTMHandshakeTimeout is used to set the timeout used during the handshake.
+// WithHandshakeTimeout is used to set the timeout used during the handshake.
 // If the timeout is reached without response from the peer then the handshake
 // will be aborted and restarted.
-func WithTMHandshakeTimeout(timeout time.Duration) TimeoutOptions {
+func WithHandshakeTimeout(timeout time.Duration) TimeoutOptions {
 	return func(manager *TimeoutManager) {
 		manager.handshakeTimeout = timeout
 	}
 }
 
-// WithTMKeepalivePing is used to send a ping packet if no packets have been
+// WithKeepalivePing is used to send a ping packet if no packets have been
 // received from the other side for the given duration. This helps keep the
 // connection alive and also ensures that the connection is closed if the
 // other side does not respond to the ping in a timely manner. After the ping
 // the connection will be closed if the other side does not respond within
 // time duration.
-func WithTMKeepalivePing(ping, pong time.Duration) TimeoutOptions {
+func WithKeepalivePing(ping, pong time.Duration) TimeoutOptions {
 	return func(manager *TimeoutManager) {
 		manager.pingTime = ping
 		manager.pongTime = pong
@@ -90,10 +90,6 @@ type config struct {
 	// between packets.
 	maxChunkSize int
 
-	// resendTimeout is the duration that will be waited before resending
-	// the packets in the current queue.
-	resendTimeout time.Duration
-
 	// recvFromStream is the function that will be used to acquire the next
 	// available packet.
 	recvFromStream recvBytesFunc
@@ -106,25 +102,17 @@ type config struct {
 	// been received and processed.
 	onFIN func()
 
-	// handshakeTimeout is the time after which the server or client
-	// will abort and restart the handshake if the expected response is
-	// not received from the peer.
-	handshakeTimeout time.Duration
-
-	pingTime time.Duration
-	pongTime time.Duration
+	timeoutOptions []TimeoutOptions
 }
 
 // newConfig constructs a new config struct.
 func newConfig(sendFunc sendBytesFunc, recvFunc recvBytesFunc,
 	n uint8) *config {
 
 	return &config{
-		n:                n,
-		s:                n + 1,
-		recvFromStream:   recvFunc,
-		sendToStream:     sendFunc,
-		resendTimeout:    defaultResendTimeout,
-		handshakeTimeout: defaultHandshakeTimeout,
+		n:              n,
+		s:              n + 1,
+		recvFromStream: recvFunc,
+		sendToStream:   sendFunc,
 	}
 }

gbn/gbn_conn.go

@@ -83,7 +83,7 @@ func newGoBackNConn(ctx context.Context, cfg *config,
 	prefix := fmt.Sprintf("(%s)", loggerPrefix)
 	plog := build.NewPrefixLog(prefix, log)
 
-	timeoutManager := NewTimeOutManager(plog)
+	timeoutManager := NewTimeOutManager(plog, cfg.timeoutOptions...)
 
 	g := &GoBackNConn{
 		cfg:               cfg,

gbn/options.go

@@ -1,7 +1,5 @@
 package gbn
 
-import "time"
-
 type Option func(conn *config)
 
 // WithMaxSendSize is used to set the maximum payload size in bytes per packet.
@@ -14,33 +12,11 @@ func WithMaxSendSize(size int) Option {
 	}
 }
 
-// WithTimeout is used to set the resend timeout. This is the time to wait
-// for ACKs before resending the queue.
-func WithTimeout(timeout time.Duration) Option {
-	return func(conn *config) {
-		conn.resendTimeout = timeout
-	}
-}
-
-// WithHandshakeTimeout is used to set the timeout used during the handshake.
-// If the timeout is reached without response from the peer then the handshake
-// will be aborted and restarted.
-func WithHandshakeTimeout(timeout time.Duration) Option {
-	return func(conn *config) {
-		conn.handshakeTimeout = timeout
-	}
-}
-
-// WithKeepalivePing is used to send a ping packet if no packets have been
-// received from the other side for the given duration. This helps keep the
-// connection alive and also ensures that the connection is closed if the
-// other side does not respond to the ping in a timely manner. After the ping
-// the connection will be closed if the other side does not respond within
-// time duration.
-func WithKeepalivePing(ping, pong time.Duration) Option {
+// WithTimeoutOptions is used to set the different timeout options that will be
+// used within gbn package.
+func WithTimeoutOptions(opts ...TimeoutOptions) Option {
 	return func(conn *config) {
-		conn.pingTime = ping
-		conn.pongTime = pong
+		conn.timeoutOptions = opts
 	}
 }
 

mailbox/client_conn.go

@@ -166,10 +166,12 @@ func NewClientConn(ctx context.Context, sid [64]byte, serverHost string,
 	}
 
 	c.gbnOptions = []gbn.Option{
-		gbn.WithTimeout(gbnTimeout),
-		gbn.WithHandshakeTimeout(gbnHandshakeTimeout),
-		gbn.WithKeepalivePing(
-			gbnClientPingTimeout, gbnPongTimeout,
+		gbn.WithTimeoutOptions(
+			gbn.WithStaticResendTimeout(gbnTimeout),
+			gbn.WithHandshakeTimeout(gbnHandshakeTimeout),
+			gbn.WithKeepalivePing(
+				gbnClientPingTimeout, gbnPongTimeout,
+			),
 		),
 		gbn.WithOnFIN(func() {
 			// We force the connection to set a new status after

mailbox/server_conn.go

@@ -80,10 +80,12 @@ func NewServerConn(ctx context.Context, serverHost string,
 		cancel: cancel,
 		quit:   make(chan struct{}),
 		gbnOptions: []gbn.Option{
-			gbn.WithTimeout(gbnTimeout),
-			gbn.WithHandshakeTimeout(gbnHandshakeTimeout),
-			gbn.WithKeepalivePing(
-				gbnServerPingTimeout, gbnPongTimeout,
+			gbn.WithTimeoutOptions(
+				gbn.WithStaticResendTimeout(gbnTimeout),
+				gbn.WithHandshakeTimeout(gbnHandshakeTimeout),
+				gbn.WithKeepalivePing(
+					gbnServerPingTimeout, gbnPongTimeout,
+				),
 			),
 		},
 		status:      ServerStatusNotConnected,