go-hep.org/x/hep@v0.38.1/xrootd/xrootd.go (about)

     1  // Copyright ©2018 The go-hep Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Package xrootd implements the XRootD protocol from
     6  //
     7  //	http://xrootd.org
     8  //
     9  // Package xrootd provides a Client and a Server.
    10  //
    11  // The NewClient function connects to a server:
    12  //
    13  //	ctx := context.Background()
    14  //
    15  //	client, err := xrootd.NewClient(ctx, addr, username)
    16  //	if err != nil {
    17  //		// handle error
    18  //	}
    19  //
    20  //	// ...
    21  //
    22  //	if err := client.Close(); err != nil {
    23  //		// handle error
    24  //	}
    25  //
    26  // The NewServer function creates a server:
    27  //
    28  //	srv := xrootd.NewServer(xrootd.Default(), nil)
    29  //	err := srv.Serve(listener)
    30  package xrootd // import "go-hep.org/x/hep/xrootd"