diff options
author | Jesse Hallam <jesse.hallam@gmail.com> | 2018-07-13 10:29:50 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-07-13 10:29:50 -0400 |
commit | 17f211c393772f30922bac595592e3fe60c2ef25 (patch) | |
tree | 4f8dfbe7949022d5da2de2db6d7b762e74fb4582 /plugin/io_rpc.go | |
parent | 5ddb08dcb47f938c9ac3a3e6338d9b3cc61c20a7 (diff) | |
download | chat-17f211c393772f30922bac595592e3fe60c2ef25.tar.gz chat-17f211c393772f30922bac595592e3fe60c2ef25.tar.bz2 chat-17f211c393772f30922bac595592e3fe60c2ef25.zip |
MM-11292: clean up plugins GoDoc (#9109)
* clean up plugins GoDoc:
- eliminate plugin.NewBlankContext() as unnecessary
- export ValidIdRegex as a string vs. the less readable var
- add/update various documentation strings
- hide everything by default, except where used by client plugins or the mattermost-server. The exception to this rule are the `*(Args|Returns)` structs which must be public for go-plugin, but are now prefixed with `Z_` with a warning not to use.
- include a top-level example to get plugin authors started
This is not a breaking change for existing plugins compiled against
plugins-v2.
* remove commented out ServeHTTPResponseWriter
* update examples to match developer docs
* add missing plugin/doc.go license header
Diffstat (limited to 'plugin/io_rpc.go')
-rw-r--r-- | plugin/io_rpc.go | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/plugin/io_rpc.go b/plugin/io_rpc.go index 7bb86b52b..18a1eb525 100644 --- a/plugin/io_rpc.go +++ b/plugin/io_rpc.go @@ -22,15 +22,11 @@ func (rwc *rwc) Close() (err error) { return } -func NewReadWriteCloser(r io.ReadCloser, w io.WriteCloser) io.ReadWriteCloser { - return &rwc{r, w} -} - -type RemoteIOReader struct { +type remoteIOReader struct { conn io.ReadWriteCloser } -func (r *RemoteIOReader) Read(b []byte) (int, error) { +func (r *remoteIOReader) Read(b []byte) (int, error) { var buf [10]byte n := binary.PutVarint(buf[:], int64(len(b))) if _, err := r.conn.Write(buf[:n]); err != nil { @@ -39,15 +35,15 @@ func (r *RemoteIOReader) Read(b []byte) (int, error) { return r.conn.Read(b) } -func (r *RemoteIOReader) Close() error { +func (r *remoteIOReader) Close() error { return r.conn.Close() } -func ConnectIOReader(conn io.ReadWriteCloser) io.ReadCloser { - return &RemoteIOReader{conn} +func connectIOReader(conn io.ReadWriteCloser) io.ReadCloser { + return &remoteIOReader{conn} } -func ServeIOReader(r io.Reader, conn io.ReadWriteCloser) { +func serveIOReader(r io.Reader, conn io.ReadWriteCloser) { cr := bufio.NewReader(conn) defer conn.Close() buf := make([]byte, 32*1024) |