go.uber.org/yarpc@v1.72.1/encoding/raw/doc.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  // Package raw provides the raw encoding for YARPC.
    22  //
    23  // To make outbound requests,
    24  //
    25  // 	client := raw.New(clientConfig)
    26  // 	resBody, err := client.Call(ctx, "submit", []byte{1, 2, 3})
    27  //
    28  // Use the Procedure function to build procedures to register against a
    29  // Router.
    30  //
    31  // 	func Submit(ctx context.Context, reqBody []byte) ([]byte, error) {
    32  // 		// ...
    33  // 	}
    34  //
    35  // 	dispatcher.Register(raw.Procedure("submit", Submit))
    36  //
    37  // Similarly, use the OnewayProcedure function to build procedures to register
    38  // against a Router.
    39  //
    40  // 	func RunTask(ctx context.Context, reqBody []byte) error {
    41  // 		// ...
    42  // 	}
    43  //
    44  // 	dispatcher.Register(raw.OnewayProcedure("RunTask", RunTask))
    45  package raw