go.uber.org/yarpc@v1.72.1/dispatcher_example_test.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 yarpc_test
    22  
    23  import (
    24  	"context"
    25  	"fmt"
    26  	"log"
    27  
    28  	"go.uber.org/yarpc"
    29  	"go.uber.org/yarpc/encoding/json"
    30  	"go.uber.org/yarpc/encoding/raw"
    31  )
    32  
    33  func ExampleDispatcher_minimal() {
    34  	dispatcher := yarpc.NewDispatcher(yarpc.Config{Name: "my-fancy-service"})
    35  	if err := dispatcher.Start(); err != nil {
    36  		log.Fatal(err)
    37  	}
    38  	defer dispatcher.Stop()
    39  	// Output:
    40  }
    41  
    42  // global dispatcher used in the registration examples
    43  var dispatcher = yarpc.NewDispatcher(yarpc.Config{Name: "service"})
    44  
    45  func ExampleDispatcher_Register_raw() {
    46  	handler := func(ctx context.Context, data []byte) ([]byte, error) {
    47  		return data, nil
    48  	}
    49  
    50  	dispatcher.Register(raw.Procedure("echo", handler))
    51  	// Output:
    52  }
    53  
    54  type Request struct {
    55  	key string
    56  }
    57  
    58  type Response struct {
    59  	val string
    60  }
    61  
    62  // Excuse the weird naming of this function. This lets is show as "JSON"
    63  // rather than "Json"
    64  
    65  func ExampleDispatcher_Register_jSON() {
    66  	handler := func(ctx context.Context, req *Request) (*Response, error) {
    67  		fmt.Println("key", req.key)
    68  		return &Response{val: "value"}, nil
    69  	}
    70  
    71  	dispatcher.Register(json.Procedure("get", handler))
    72  	// Output:
    73  }