aboutsummaryrefslogtreecommitdiffstats
path: root/api
diff options
context:
space:
mode:
authormhalaj1 <matus.halaj@pantheon.tech>2021-08-26 20:15:08 +0200
committermhalaj1 <matus.halaj@pantheon.tech>2021-09-07 15:24:53 +0200
commitc09ee3241377aae2530a73d48c4e20641d76d0ee (patch)
tree219fd1f7d9ba595f0f4c8dac9796bc76ce3556fc /api
parentdebc52dea8a81417bb08ca5bb934c7876b6d65e0 (diff)
Refactoring and fixes
* refactor creation of new channel * add missing closing of created streams * correct documentation regarding thread safety of stream Signed-off-by: mhalaj1 <matus.halaj@pantheon.tech> Change-Id: Ic601efff298fcbdecaafab83fa236253af69de21
Diffstat (limited to 'api')
-rw-r--r--api/api.go11
1 files changed, 3 insertions, 8 deletions
diff --git a/api/api.go b/api/api.go
index 3089f24..c4f069f 100644
--- a/api/api.go
+++ b/api/api.go
@@ -36,21 +36,16 @@ type Connection interface {
// 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