ref: Rename things called *Context to *Call.
This is part of an effort to clarify naming around contexts. We are
going to rename ServerContext and security.Context to ServerCall and
security.Call respectively. Now when people say "context" we will
know they mean context.T.
In a follow-up change I can try to change the variable names ctx and
context to call. I also need to merge the security.Call interface into
ClientCall and remove redundant access to LocalPrincipal.
MultiPart: 5/11
Change-Id: I6d7684b2fecacce04e9fd7e0a16c88b41f4269ab
diff --git a/examples/rps/rpsbot/impl.go b/examples/rps/rpsbot/impl.go
index 572896d..5c7b45e 100644
--- a/examples/rps/rpsbot/impl.go
+++ b/examples/rps/rpsbot/impl.go
@@ -3,11 +3,11 @@
import (
"errors"
- "v.io/x/ref/examples/rps"
"v.io/v23/context"
"v.io/v23/ipc"
"v.io/v23/vtrace"
"v.io/x/lib/vlog"
+ "v.io/x/ref/examples/rps"
)
// RPS implements rps.RockPaperScissorsServerMethods
@@ -34,12 +34,12 @@
return r.scoreKeeper
}
-func (r *RPS) CreateGame(ctx ipc.ServerContext, opts rps.GameOptions) (rps.GameID, error) {
+func (r *RPS) CreateGame(ctx ipc.ServerCall, opts rps.GameOptions) (rps.GameID, error) {
if vlog.V(1) {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.Infof("CreateGame %+v from %v", opts, b)
}
- names, _ := ctx.LocalBlessings().ForContext(ctx)
+ names, _ := ctx.LocalBlessings().ForCall(ctx)
if len(names) == 0 {
return rps.GameID{}, errors.New("no names provided for context")
}
@@ -47,7 +47,7 @@
}
func (r *RPS) Play(ctx rps.JudgePlayContext, id rps.GameID) (rps.PlayResult, error) {
- names, _ := ctx.RemoteBlessings().ForContext(ctx)
+ names, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Play %+v from %v", id, names)
if len(names) == 0 {
return rps.PlayResult{}, errors.New("no names provided for context")
@@ -55,15 +55,15 @@
return r.judge.play(ctx, names[0], id)
}
-func (r *RPS) Challenge(ctx ipc.ServerContext, address string, id rps.GameID, opts rps.GameOptions) error {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+func (r *RPS) Challenge(ctx ipc.ServerCall, address string, id rps.GameID, opts rps.GameOptions) error {
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Challenge (%q, %+v, %+v) from %v", address, id, opts, b)
newctx, _ := vtrace.SetNewTrace(r.ctx)
return r.player.challenge(newctx, address, id, opts)
}
-func (r *RPS) Record(ctx ipc.ServerContext, score rps.ScoreCard) error {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+func (r *RPS) Record(ctx ipc.ServerCall, score rps.ScoreCard) error {
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Record (%+v) from %v", score, b)
return r.scoreKeeper.Record(ctx, score)
}
diff --git a/examples/rps/rpsbot/scorekeeper.go b/examples/rps/rpsbot/scorekeeper.go
index 429647f..e201a84 100644
--- a/examples/rps/rpsbot/scorekeeper.go
+++ b/examples/rps/rpsbot/scorekeeper.go
@@ -1,12 +1,12 @@
package main
import (
- "v.io/x/ref/examples/rps"
- "v.io/x/ref/examples/rps/common"
"v.io/core/veyron/lib/stats"
"v.io/core/veyron/lib/stats/counter"
"v.io/v23/ipc"
"v.io/x/lib/vlog"
+ "v.io/x/ref/examples/rps"
+ "v.io/x/ref/examples/rps/common"
)
type ScoreKeeper struct {
@@ -23,8 +23,8 @@
return k.numRecords.Value()
}
-func (k *ScoreKeeper) Record(ctx ipc.ServerContext, score rps.ScoreCard) error {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+func (k *ScoreKeeper) Record(ctx ipc.ServerCall, score rps.ScoreCard) error {
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Received ScoreCard from %v:", b)
vlog.VI(1).Info(common.FormatScoreCard(score))
k.numRecords.Incr(1)
diff --git a/examples/rps/rpsplayer/main.go b/examples/rps/rpsplayer/main.go
index 13e40b8..960ce5e 100644
--- a/examples/rps/rpsplayer/main.go
+++ b/examples/rps/rpsplayer/main.go
@@ -71,8 +71,8 @@
return prev
}
-func (i *impl) Challenge(ctx ipc.ServerContext, address string, id rps.GameID, opts rps.GameOptions) error {
- remote, _ := ctx.RemoteBlessings().ForContext(ctx)
+func (i *impl) Challenge(ctx ipc.ServerCall, address string, id rps.GameID, opts rps.GameOptions) error {
+ remote, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Challenge (%q, %+v) from %v", address, id, remote)
// When setDecline(true) returns, future challenges will be declined.
// Whether the current challenge should be considered depends on the
diff --git a/examples/rps/rpsscorekeeper/main.go b/examples/rps/rpsscorekeeper/main.go
index 6485360..433499c 100644
--- a/examples/rps/rpsscorekeeper/main.go
+++ b/examples/rps/rpsscorekeeper/main.go
@@ -23,8 +23,8 @@
ch chan rps.ScoreCard
}
-func (i *impl) Record(ctx ipc.ServerContext, score rps.ScoreCard) error {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+func (i *impl) Record(ctx ipc.ServerCall, score rps.ScoreCard) error {
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.VI(1).Infof("Record (%+v) from %v", score, b)
i.ch <- score
return nil
diff --git a/examples/rps/service.vdl.go b/examples/rps/service.vdl.go
index 2b6cbcf..387263f 100644
--- a/examples/rps/service.vdl.go
+++ b/examples/rps/service.vdl.go
@@ -249,7 +249,7 @@
// identifier that can be used by the players to join the game.
CreateGame(ctx *context.T, Opts GameOptions, opts ...ipc.CallOpt) (GameID, error)
// Play lets a player join an existing game and play.
- Play(ctx *context.T, ID GameID, opts ...ipc.CallOpt) (JudgePlayCall, error)
+ Play(ctx *context.T, ID GameID, opts ...ipc.CallOpt) (JudgePlayClientCall, error)
}
// JudgeClientStub adds universal methods to JudgeClientMethods.
@@ -282,7 +282,7 @@
}
func (c implJudgeClientStub) CreateGame(ctx *context.T, i0 GameOptions, opts ...ipc.CallOpt) (o0 GameID, err error) {
- var call ipc.Call
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "CreateGame", []interface{}{i0}, opts...); err != nil {
return
}
@@ -290,12 +290,12 @@
return
}
-func (c implJudgeClientStub) Play(ctx *context.T, i0 GameID, opts ...ipc.CallOpt) (ocall JudgePlayCall, err error) {
- var call ipc.Call
+func (c implJudgeClientStub) Play(ctx *context.T, i0 GameID, opts ...ipc.CallOpt) (ocall JudgePlayClientCall, err error) {
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "Play", []interface{}{i0}, opts...); err != nil {
return
}
- ocall = &implJudgePlayCall{Call: call}
+ ocall = &implJudgePlayClientCall{ClientCall: call}
return
}
@@ -332,8 +332,8 @@
}
}
-// JudgePlayCall represents the call returned from Judge.Play.
-type JudgePlayCall interface {
+// JudgePlayClientCall represents the call returned from Judge.Play.
+type JudgePlayClientCall interface {
JudgePlayClientStream
// Finish performs the equivalent of SendStream().Close, then blocks until
// the server is done, and returns the positional return values for the call.
@@ -348,13 +348,13 @@
Finish() (PlayResult, error)
}
-type implJudgePlayCall struct {
- ipc.Call
+type implJudgePlayClientCall struct {
+ ipc.ClientCall
valRecv JudgeAction
errRecv error
}
-func (c *implJudgePlayCall) RecvStream() interface {
+func (c *implJudgePlayClientCall) RecvStream() interface {
Advance() bool
Value() JudgeAction
Err() error
@@ -363,7 +363,7 @@
}
type implJudgePlayCallRecv struct {
- c *implJudgePlayCall
+ c *implJudgePlayClientCall
}
func (c implJudgePlayCallRecv) Advance() bool {
@@ -379,7 +379,7 @@
}
return c.c.errRecv
}
-func (c *implJudgePlayCall) SendStream() interface {
+func (c *implJudgePlayClientCall) SendStream() interface {
Send(item PlayerAction) error
Close() error
} {
@@ -387,7 +387,7 @@
}
type implJudgePlayCallSend struct {
- c *implJudgePlayCall
+ c *implJudgePlayClientCall
}
func (c implJudgePlayCallSend) Send(item PlayerAction) error {
@@ -396,8 +396,8 @@
func (c implJudgePlayCallSend) Close() error {
return c.c.CloseSend()
}
-func (c *implJudgePlayCall) Finish() (o0 PlayResult, err error) {
- err = c.Call.Finish(&o0)
+func (c *implJudgePlayClientCall) Finish() (o0 PlayResult, err error) {
+ err = c.ClientCall.Finish(&o0)
return
}
@@ -406,7 +406,7 @@
type JudgeServerMethods interface {
// CreateGame creates a new game with the given game options and returns a game
// identifier that can be used by the players to join the game.
- CreateGame(ctx ipc.ServerContext, Opts GameOptions) (GameID, error)
+ CreateGame(ctx ipc.ServerCall, Opts GameOptions) (GameID, error)
// Play lets a player join an existing game and play.
Play(ctx JudgePlayContext, ID GameID) (PlayResult, error)
}
@@ -418,7 +418,7 @@
type JudgeServerStubMethods interface {
// CreateGame creates a new game with the given game options and returns a game
// identifier that can be used by the players to join the game.
- CreateGame(ctx ipc.ServerContext, Opts GameOptions) (GameID, error)
+ CreateGame(ctx ipc.ServerCall, Opts GameOptions) (GameID, error)
// Play lets a player join an existing game and play.
Play(ctx *JudgePlayContextStub, ID GameID) (PlayResult, error)
}
@@ -452,7 +452,7 @@
gs *ipc.GlobState
}
-func (s implJudgeServerStub) CreateGame(ctx ipc.ServerContext, i0 GameOptions) (GameID, error) {
+func (s implJudgeServerStub) CreateGame(ctx ipc.ServerCall, i0 GameOptions) (GameID, error) {
return s.impl.CreateGame(ctx, i0)
}
@@ -526,7 +526,7 @@
// JudgePlayContext represents the context passed to Judge.Play.
type JudgePlayContext interface {
- ipc.ServerContext
+ ipc.ServerCall
JudgePlayServerStream
}
@@ -625,7 +625,7 @@
}
func (c implPlayerClientStub) Challenge(ctx *context.T, i0 string, i1 GameID, i2 GameOptions, opts ...ipc.CallOpt) (err error) {
- var call ipc.Call
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "Challenge", []interface{}{i0, i1, i2}, opts...); err != nil {
return
}
@@ -640,7 +640,7 @@
type PlayerServerMethods interface {
// Challenge is used by other players to challenge this player to a game. If
// the challenge is accepted, the method returns nil.
- Challenge(ctx ipc.ServerContext, Address string, ID GameID, Opts GameOptions) error
+ Challenge(ctx ipc.ServerCall, Address string, ID GameID, Opts GameOptions) error
}
// PlayerServerStubMethods is the server interface containing
@@ -678,7 +678,7 @@
gs *ipc.GlobState
}
-func (s implPlayerServerStub) Challenge(ctx ipc.ServerContext, i0 string, i1 GameID, i2 GameOptions) error {
+func (s implPlayerServerStub) Challenge(ctx ipc.ServerCall, i0 string, i1 GameID, i2 GameOptions) error {
return s.impl.Challenge(ctx, i0, i1, i2)
}
@@ -750,7 +750,7 @@
}
func (c implScoreKeeperClientStub) Record(ctx *context.T, i0 ScoreCard, opts ...ipc.CallOpt) (err error) {
- var call ipc.Call
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "Record", []interface{}{i0}, opts...); err != nil {
return
}
@@ -763,7 +763,7 @@
//
// ScoreKeeper receives the outcome of games from Judges.
type ScoreKeeperServerMethods interface {
- Record(ctx ipc.ServerContext, Score ScoreCard) error
+ Record(ctx ipc.ServerCall, Score ScoreCard) error
}
// ScoreKeeperServerStubMethods is the server interface containing
@@ -801,7 +801,7 @@
gs *ipc.GlobState
}
-func (s implScoreKeeperServerStub) Record(ctx ipc.ServerContext, i0 ScoreCard) error {
+func (s implScoreKeeperServerStub) Record(ctx ipc.ServerCall, i0 ScoreCard) error {
return s.impl.Record(ctx, i0)
}
diff --git a/examples/tunnel/tunnel.vdl.go b/examples/tunnel/tunnel.vdl.go
index cd212f8..2cd988e 100644
--- a/examples/tunnel/tunnel.vdl.go
+++ b/examples/tunnel/tunnel.vdl.go
@@ -154,13 +154,13 @@
// the byte stream is forwarded to the requested network address and all the
// data received from that network connection is sent back in the reply
// stream.
- Forward(ctx *context.T, network string, address string, opts ...ipc.CallOpt) (TunnelForwardCall, error)
+ Forward(ctx *context.T, network string, address string, opts ...ipc.CallOpt) (TunnelForwardClientCall, error)
// The Shell method is used to either run shell commands remotely, or to open
// an interactive shell. The data received over the byte stream is sent to the
// shell's stdin, and the data received from the shell's stdout and stderr is
// sent back in the reply stream. It returns the exit status of the shell
// command.
- Shell(ctx *context.T, command string, shellOpts ShellOpts, opts ...ipc.CallOpt) (TunnelShellCall, error)
+ Shell(ctx *context.T, command string, shellOpts ShellOpts, opts ...ipc.CallOpt) (TunnelShellClientCall, error)
}
// TunnelClientStub adds universal methods to TunnelClientMethods.
@@ -192,21 +192,21 @@
return v23.GetClient(ctx)
}
-func (c implTunnelClientStub) Forward(ctx *context.T, i0 string, i1 string, opts ...ipc.CallOpt) (ocall TunnelForwardCall, err error) {
- var call ipc.Call
+func (c implTunnelClientStub) Forward(ctx *context.T, i0 string, i1 string, opts ...ipc.CallOpt) (ocall TunnelForwardClientCall, err error) {
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "Forward", []interface{}{i0, i1}, opts...); err != nil {
return
}
- ocall = &implTunnelForwardCall{Call: call}
+ ocall = &implTunnelForwardClientCall{ClientCall: call}
return
}
-func (c implTunnelClientStub) Shell(ctx *context.T, i0 string, i1 ShellOpts, opts ...ipc.CallOpt) (ocall TunnelShellCall, err error) {
- var call ipc.Call
+func (c implTunnelClientStub) Shell(ctx *context.T, i0 string, i1 ShellOpts, opts ...ipc.CallOpt) (ocall TunnelShellClientCall, err error) {
+ var call ipc.ClientCall
if call, err = c.c(ctx).StartCall(ctx, c.name, "Shell", []interface{}{i0, i1}, opts...); err != nil {
return
}
- ocall = &implTunnelShellCall{Call: call}
+ ocall = &implTunnelShellClientCall{ClientCall: call}
return
}
@@ -243,8 +243,8 @@
}
}
-// TunnelForwardCall represents the call returned from Tunnel.Forward.
-type TunnelForwardCall interface {
+// TunnelForwardClientCall represents the call returned from Tunnel.Forward.
+type TunnelForwardClientCall interface {
TunnelForwardClientStream
// Finish performs the equivalent of SendStream().Close, then blocks until
// the server is done, and returns the positional return values for the call.
@@ -259,13 +259,13 @@
Finish() error
}
-type implTunnelForwardCall struct {
- ipc.Call
+type implTunnelForwardClientCall struct {
+ ipc.ClientCall
valRecv []byte
errRecv error
}
-func (c *implTunnelForwardCall) RecvStream() interface {
+func (c *implTunnelForwardClientCall) RecvStream() interface {
Advance() bool
Value() []byte
Err() error
@@ -274,7 +274,7 @@
}
type implTunnelForwardCallRecv struct {
- c *implTunnelForwardCall
+ c *implTunnelForwardClientCall
}
func (c implTunnelForwardCallRecv) Advance() bool {
@@ -290,7 +290,7 @@
}
return c.c.errRecv
}
-func (c *implTunnelForwardCall) SendStream() interface {
+func (c *implTunnelForwardClientCall) SendStream() interface {
Send(item []byte) error
Close() error
} {
@@ -298,7 +298,7 @@
}
type implTunnelForwardCallSend struct {
- c *implTunnelForwardCall
+ c *implTunnelForwardClientCall
}
func (c implTunnelForwardCallSend) Send(item []byte) error {
@@ -307,8 +307,8 @@
func (c implTunnelForwardCallSend) Close() error {
return c.c.CloseSend()
}
-func (c *implTunnelForwardCall) Finish() (err error) {
- err = c.Call.Finish()
+func (c *implTunnelForwardClientCall) Finish() (err error) {
+ err = c.ClientCall.Finish()
return
}
@@ -345,8 +345,8 @@
}
}
-// TunnelShellCall represents the call returned from Tunnel.Shell.
-type TunnelShellCall interface {
+// TunnelShellClientCall represents the call returned from Tunnel.Shell.
+type TunnelShellClientCall interface {
TunnelShellClientStream
// Finish performs the equivalent of SendStream().Close, then blocks until
// the server is done, and returns the positional return values for the call.
@@ -361,13 +361,13 @@
Finish() (int32, error)
}
-type implTunnelShellCall struct {
- ipc.Call
+type implTunnelShellClientCall struct {
+ ipc.ClientCall
valRecv ServerShellPacket
errRecv error
}
-func (c *implTunnelShellCall) RecvStream() interface {
+func (c *implTunnelShellClientCall) RecvStream() interface {
Advance() bool
Value() ServerShellPacket
Err() error
@@ -376,7 +376,7 @@
}
type implTunnelShellCallRecv struct {
- c *implTunnelShellCall
+ c *implTunnelShellClientCall
}
func (c implTunnelShellCallRecv) Advance() bool {
@@ -392,7 +392,7 @@
}
return c.c.errRecv
}
-func (c *implTunnelShellCall) SendStream() interface {
+func (c *implTunnelShellClientCall) SendStream() interface {
Send(item ClientShellPacket) error
Close() error
} {
@@ -400,7 +400,7 @@
}
type implTunnelShellCallSend struct {
- c *implTunnelShellCall
+ c *implTunnelShellClientCall
}
func (c implTunnelShellCallSend) Send(item ClientShellPacket) error {
@@ -409,8 +409,8 @@
func (c implTunnelShellCallSend) Close() error {
return c.c.CloseSend()
}
-func (c *implTunnelShellCall) Finish() (o0 int32, err error) {
- err = c.Call.Finish(&o0)
+func (c *implTunnelShellClientCall) Finish() (o0 int32, err error) {
+ err = c.ClientCall.Finish(&o0)
return
}
@@ -550,7 +550,7 @@
// TunnelForwardContext represents the context passed to Tunnel.Forward.
type TunnelForwardContext interface {
- ipc.ServerContext
+ ipc.ServerCall
TunnelForwardServerStream
}
@@ -634,7 +634,7 @@
// TunnelShellContext represents the context passed to Tunnel.Shell.
type TunnelShellContext interface {
- ipc.ServerContext
+ ipc.ServerCall
TunnelShellServerStream
}
diff --git a/examples/tunnel/tunneld/impl.go b/examples/tunnel/tunneld/impl.go
index 685f385..c2516fb 100644
--- a/examples/tunnel/tunneld/impl.go
+++ b/examples/tunnel/tunneld/impl.go
@@ -12,9 +12,9 @@
"os/exec"
"syscall"
+ "v.io/x/lib/vlog"
"v.io/x/ref/examples/tunnel"
"v.io/x/ref/examples/tunnel/tunnelutil"
- "v.io/x/lib/vlog"
)
// T implements tunnel.TunnelServerMethods
@@ -28,7 +28,7 @@
if err != nil {
return err
}
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
name := fmt.Sprintf("RemoteBlessings:%v LocalAddr:%v RemoteAddr:%v", b, conn.LocalAddr(), conn.RemoteAddr())
vlog.Infof("TUNNEL START: %v", name)
err = tunnelutil.Forward(conn, ctx.SendStream(), ctx.RecvStream())
@@ -37,7 +37,7 @@
}
func (t *T) Shell(ctx tunnel.TunnelShellContext, command string, shellOpts tunnel.ShellOpts) (int32, error) {
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.Infof("SHELL START for %v: %q", b, command)
shell, err := findShell()
if err != nil {
@@ -108,7 +108,7 @@
select {
case runErr := <-runIOManager(stdin, stdout, stderr, ptyFd, ctx):
- b, _ := ctx.RemoteBlessings().ForContext(ctx)
+ b, _ := ctx.RemoteBlessings().ForCall(ctx)
vlog.Infof("SHELL END for %v: %q (%v)", b, command, runErr)
return harvestExitcode(c.Process, runErr)
case <-ctx.Context().Done():
diff --git a/examples/tunnel/vsh/iomanager.go b/examples/tunnel/vsh/iomanager.go
index 0ce8681..cbc7c2d 100644
--- a/examples/tunnel/vsh/iomanager.go
+++ b/examples/tunnel/vsh/iomanager.go
@@ -8,12 +8,12 @@
"sync"
"syscall"
+ "v.io/x/lib/vlog"
"v.io/x/ref/examples/tunnel"
"v.io/x/ref/examples/tunnel/tunnelutil"
- "v.io/x/lib/vlog"
)
-func runIOManager(stdin io.Reader, stdout, stderr io.Writer, stream tunnel.TunnelShellCall) error {
+func runIOManager(stdin io.Reader, stdout, stderr io.Writer, stream tunnel.TunnelShellClientCall) error {
m := ioManager{stdin: stdin, stdout: stdout, stderr: stderr, stream: stream}
return m.run()
}
@@ -23,7 +23,7 @@
type ioManager struct {
stdin io.Reader
stdout, stderr io.Writer
- stream tunnel.TunnelShellCall
+ stream tunnel.TunnelShellClientCall
// streamError receives errors coming from stream operations.
streamError chan error
