Skip to content

Commit 098f255

Browse files
committed
Fix docstrings.
1 parent 4fb4e8c commit 098f255

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

rpc/transport/transport.go

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,9 @@ type Transport interface {
2727
// has no effect. Before releasing the message, Send() MAY be called
2828
// at most once to send the mssage.
2929
//
30-
// OutgoingMessage instances returned by NewMessage must have a nil
31-
// CapTable. When OutgoingMessage.Release() is called, the underlying
32-
// *capnp.Message will be released. This will also release any clients
33-
// in the message's CapTable and release its Arena.
30+
// When Release() is called, the underlying *capnp.Message SHOULD be
31+
// released. This will also release any clients in the CapTable and
32+
// release its Arena.
3433
//
3534
// The Arena in the returned message should be fast at allocating new
3635
// segments. The returned ReleaseFunc MUST be safe to call concurrently
@@ -43,10 +42,9 @@ type Transport interface {
4342
// concurrently with RecvMessage or with any other release function
4443
// returned by RecvMessage.
4544
//
46-
// IncomingMessage instances returned by RecvMessage must have a nil
47-
// CapTable. When IncomingMessage.Release() is called, the underlying
48-
// *capnp.Message will be released. This will also release any clients
49-
// in the message's CapTable and release its Arena.
45+
// When Release() is called, the underlying *capnp.Message SHOULD be
46+
// released. This will also release any clients in the CapTable and
47+
// release its Arena.
5048
//
5149
// The Arena in the returned message should not fetch segments lazily;
5250
// the Arena should be fast to access other segments.
@@ -63,9 +61,8 @@ type Transport interface {
6361
// use. Before releasing an ougoing message, Send() MAY be called at
6462
// most once to send the message over the transport that produced it.
6563
//
66-
// Implementations MUST ensure the cap table is empty before Send is
67-
// called, and SHOULD release the underlying *capnp.Message when the
68-
// Release() method is called.
64+
// Implementations SHOULD release the underlying *capnp.Message when
65+
// the Release() method is called.
6966
//
7067
// Release() MUST be idempotent, and calls to Send() after a call to
7168
// Release MUST panic.

0 commit comments

Comments
 (0)