Send API returns a write-only channel #302
Conversation
This simplifies APIs by removing TrySend and SendCtx(), and allowing the caller of Send more flexability, More flexability is provided by a channel as it allows the caller to chose to use it in a select, range loop, etc. when writing a message.
| // IsLocal returns true if the session is local. | ||
| IsLocal() bool | ||
| // Send returns the peer's outgoing message channel. | ||
| Send() chan<- Message |
There was a problem hiding this comment.
I find naming Send confusing. It was clear in previous meaning and value. But looking somewhere in the code at line peer.Send() it is not clear that it returns a channel now. And as the signature is changed (thus making new design incompatible with old behaviour) - maybe we can give it better name? At least smth like SendCh? What do you think?
There was a problem hiding this comment.
The reason I left it as Send is because that pairs with the existing Recv function that also returns a channel. If we change Send to something else, then we should also change Recv.
// Recv returns a channel of messages from the peer.
Recv() <-chan Message
// Send returns the peer's outgoing message channel.
Send() chan<- MessageThere was a problem hiding this comment.
Yeah, I see. While we're making a refactoring and can give better naming for both, I'm ok to keep it as is. So it's up to you: if you agree - let's rename! If no - no problem.
Co-authored-by: Konstantin Burkalev <[email protected]>
Co-authored-by: Konstantin Burkalev <[email protected]>
Description, Motivation and Context
This PR simplifies APIs by removing
TrySendandSendCtx, and allows the caller ofSendmore flexability. More flexibility is provided by a channel as it allows the caller to choose to use it in a select, range loop, etc. when writing a message.Addresses Issue #291
What is the current behavior?
A message is passed into the blocking
Sendor non-blockingTrySend, or a message and context is passed intoSendCtx.What is the new behavior?
The
Sendfunction returns a write-only message channel. TheTrySendandSendCtxfunctions disappear.What kind of change does this PR introduce?
This might not be considered a breaking change if
Sendis considered an internal API used when writing your own router or client implementation using thewamppackage. You can see this is the case since all of the examples do not need to change.Checklist: