github.com/braveheart12/insolar-09-08-19@v0.8.7/network/transport/doc.go (about)

     1  /*
     2   * The Clear BSD License
     3   *
     4   * Copyright (c) 2019 Insolar Technologies
     5   *
     6   * All rights reserved.
     7   *
     8   * Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
     9   *
    10   *  Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    11   *  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    12   *  Neither the name of Insolar Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    13   *
    14   * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    15   *
    16   */
    17  
    18  /*
    19  Package transport provides network transport interface. It allows to abstract our network from physical transport.
    20  It can either be IP based network or any other kind of packet courier (e.g. an industrial packet bus).
    21  
    22  Package exports simple interfaces for easily defining new transports.
    23  
    24  For now we provide two implementations of transport.
    25  The default is UTPTransport which using BitTorrent µTP protocol.
    26  
    27  Usage:
    28  
    29  	var conn net.PacketConn
    30  	// get udp connection anywhere
    31  
    32  	tp, _ := transport.NewUTPTransport(conn)
    33  	msg := &packet.Packet{}
    34  
    35  	// Send the async queries and wait for a future
    36  	future, err := tp.SendRequest(msg)
    37  	if err != nil {
    38  		panic(err)
    39  	}
    40  
    41  	select {
    42  	case response := <-future.Result():
    43  		// Channel was closed
    44  		if response == nil {
    45  			panic("chanel closed unexpectedly")
    46  		}
    47  
    48  		// do something with response
    49  
    50  	case <-time.After(1 * time.Second):
    51  		future.Cancel()
    52  	}
    53  
    54  */
    55  package transport