github.com/noisysockets/noisysockets@v0.21.2-0.20240515114641-7f467e651c90/internal/transport/source_sink.go (about)

     1  // SPDX-License-Identifier: MPL-2.0
     2  /*
     3   * Copyright (C) 2024 The Noisy Sockets Authors.
     4   *
     5   * This Source Code Form is subject to the terms of the Mozilla Public
     6   * License, v. 2.0. If a copy of the MPL was not distributed with this
     7   * file, You can obtain one at http://mozilla.org/MPL/2.0/.
     8   *
     9   * Portions of this file are based on code originally from wireguard-go,
    10   *
    11   * Copyright (C) 2017-2023 WireGuard LLC. All Rights Reserved.
    12   *
    13   * Permission is hereby granted, free of charge, to any person obtaining a copy of
    14   * this software and associated documentation files (the "Software"), to deal in
    15   * the Software without restriction, including without limitation the rights to
    16   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
    17   * of the Software, and to permit persons to whom the Software is furnished to do
    18   * so, subject to the following conditions:
    19   *
    20   * The above copyright notice and this permission notice shall be included in all
    21   * copies or substantial portions of the Software.
    22   *
    23   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    24   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    25   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    26   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    27   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    28   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    29   * SOFTWARE.
    30   */
    31  
    32  package transport
    33  
    34  import (
    35  	"io"
    36  
    37  	"github.com/noisysockets/noisysockets/types"
    38  )
    39  
    40  type SourceSink interface {
    41  	io.Closer
    42  
    43  	// Read one or more packets from the Transport (without any additional headers).
    44  	// On a successful read it returns the number of packets read, and sets
    45  	// packet lengths within the sizes slice. len(sizes) must be >= len(bufs).
    46  	// A nonzero offset can be used to instruct the Transport on where to begin
    47  	// reading into each element of the bufs slice.
    48  	Read(bufs [][]byte, sizes []int, destinations []types.NoisePublicKey, offset int) (int, error)
    49  
    50  	// Write one or more packets to the transport (without any additional headers).
    51  	// On a successful write it returns the number of packets written. A nonzero
    52  	// offset can be used to instruct the Transport on where to begin writing from
    53  	// each packet contained within the bufs slice.
    54  	Write(bufs [][]byte, sources []types.NoisePublicKey, offset int) (int, error)
    55  
    56  	// MTU returns the maximum transmission unit of the source/sink.
    57  	MTU() int
    58  
    59  	// BatchSize returns the preferred/max number of packets that can be read or
    60  	// written in a single read/write call. BatchSize must not change over the
    61  	// lifetime of a Transport.
    62  	BatchSize() int
    63  }