go.uber.org/yarpc@v1.72.1/encoding/json/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 json provides the JSON encoding for YARPC.
    22  //
    23  // To make outbound requests using this encoding,
    24  //
    25  // 	client := json.New(clientConfig)
    26  // 	var resBody GetValueResponse
    27  // 	err := client.Call(ctx, "getValue", &GetValueRequest{...}, &resBody)
    28  //
    29  // To register a JSON procedure, define functions in the format,
    30  //
    31  // 	f(ctx context.Context, body $reqBody) ($resBody, error)
    32  //
    33  // Where '$reqBody' and '$resBody' are either pointers to structs representing
    34  // your request and response objects, or map[string]interface{}.
    35  //
    36  // Use the Procedure function to build procedures to register against a
    37  // Router.
    38  //
    39  //  dispatcher.Register(json.Procedure("getValue", GetValue))
    40  //  dispatcher.Register(json.Procedure("setValue", SetValue))
    41  //
    42  // Similarly, to register a oneway JSON procedure, define functions in the
    43  // format,
    44  //
    45  // 	f(ctx context.Context, body $reqBody) error
    46  //
    47  // Where $reqBody is a map[string]interface{} or pointer to a struct.
    48  //
    49  // Use the OnewayProcedure function to build procedures to register against a
    50  // Router.
    51  //
    52  //  dispatcher.Register(json.OnewayProcedure("setValue", SetValue))
    53  //  dispatcher.Register(json.OnewayProcedure("runTask", RunTask))
    54  //
    55  package json