X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=api%2Fapi.go;h=c4f069faadcfbf840eafab03785f443c2ee65b86;hb=a4112fac7b86fe09650d2bb57969fe46404edd7d;hp=977b02ee1ba92e1b59997bdb06c34acaba756361;hpb=df67791c6ffc96331f75aec7d3addfe2efca7739;p=govpp.git

diff --git a/api/api.go b/api/api.go
index 977b02e..c4f069f 100644
--- a/api/api.go
+++ b/api/api.go
@@ -1,4 +1,4 @@
-//  Copyright (c) 2020 Cisco and/or its affiliates.
+//  Copyright (c) 2021 Cisco and/or its affiliates.
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -25,31 +25,27 @@ import (
 type Connection interface {
 	// NewStream creates a new stream for sending and receiving messages.
 	// Context can be used to close the stream using cancel or timeout.
-	NewStream(ctx context.Context) (Stream, error)
+	NewStream(ctx context.Context, options ...StreamOption) (Stream, error)
 
 	// Invoke can be used for a simple request-reply RPC.
-	// It creates stream and calls SendMsg with req and RecvMsg with reply.
+	// It creates stream and calls SendMsg with req and RecvMsg which returns
+	// reply.
 	Invoke(ctx context.Context, req Message, reply Message) error
 }
 
 // Stream provides low-level access for sending and receiving messages.
 // Users should handle correct type and ordering of messages.
 //
+// It is not safe to call these methods on the same stream in different
+// goroutines.
+//
 // NOTE: This API is EXPERIMENTAL.
 type Stream interface {
 	// SendMsg sends a message to the client.
 	// It blocks until message is sent to the transport.
-	//
-	// It is safe to have a goroutine calling SendMsg and another goroutine
-	// calling RecvMsg on the same stream at the same time, but it is not safe
-	// to call SendMsg on the same stream in different goroutines.
 	SendMsg(Message) error
 
 	// RecvMsg blocks until a message is received or error occurs.
-	//
-	// It is safe to have a goroutine calling SendMsg and another goroutine
-	// calling RecvMsg on the same stream at the same time, but it is not safe
-	// to call SendMsg on the same stream in different goroutines.
 	RecvMsg() (Message, error)
 
 	// Close closes the stream. Calling SendMsg and RecvMsg will return error
@@ -57,6 +53,12 @@ type Stream interface {
 	Close() error
 }
 
+// StreamOption allows customizing a Stream. Available options are:
+// - WithRequestSize
+// - WithReplySize
+// - WithReplyTimeout
+type StreamOption func(Stream)
+
 // ChannelProvider provides the communication channel with govpp core.
 type ChannelProvider interface {
 	// NewAPIChannel returns a new channel for communication with VPP via govpp core.