gitlab.com/aquachain/aquachain@v1.17.16-rc3.0.20221018032414-e3ddf1e1c055/rpc/rpcclient/ipc.go (about)

     1  // Copyright 2018 The aquachain Authors
     2  // This file is part of the aquachain library.
     3  //
     4  // The aquachain 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 aquachain 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 aquachain library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package rpc
    18  
    19  import (
    20  	"context"
    21  	"net"
    22  )
    23  
    24  // DialIPC create a new IPC client that connects to the given endpoint. On Unix it assumes
    25  // the endpoint is the full path to a unix socket, and Windows the endpoint is an
    26  // identifier for a named pipe.
    27  //
    28  // The context is used for the initial connection establishment. It does not
    29  // affect subsequent interactions with the client.
    30  func DialIPC(ctx context.Context, endpoint string) (*Client, error) {
    31  	return newClient(ctx, func(ctx context.Context) (net.Conn, error) {
    32  		return newIPCConnection(ctx, endpoint)
    33  	})
    34  }