github.com/core-coin/go-core/v2@v2.1.9/rpc/client_opt_test.go (about)

     1  // Copyright 2024 by the Authors
     2  // This file is part of the go-core library.
     3  //
     4  // The go-core library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-core library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-core library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package rpc_test
    18  
    19  import (
    20  	"context"
    21  	"net/http"
    22  	"time"
    23  
    24  	"github.com/core-coin/go-core/v2/rpc"
    25  )
    26  
    27  // This example configures a HTTP-based RPC client with two options - one setting the
    28  // overall request timeout, the other adding a custom HTTP header to all requests.
    29  func ExampleDialOptions() {
    30  	tokenHeader := rpc.WithHeader("x-token", "foo")
    31  	httpClient := rpc.WithHTTPClient(&http.Client{
    32  		Timeout: 10 * time.Second,
    33  	})
    34  
    35  	ctx := context.Background()
    36  	c, err := rpc.DialOptions(ctx, "http://rpc.example.com", httpClient, tokenHeader)
    37  	if err != nil {
    38  		panic(err)
    39  	}
    40  	c.Close()
    41  }