STELLAR-3700 - Add option to disable TCP/UDP proxy for streams

cmd/flag/proxy_flags.go

@@ -30,7 +30,7 @@ var (
 	defaultProxyProtocol = "udp"
 
 	// Supported proxy.
-	availableProxy = []string{"udp", "tcp"}
+	availableProxy = []string{"udp", "tcp", "disabled"}
 	// Default listen host for UDP.
 	defaultUDPListenHost = "127.0.0.1"
 	// Default listen port for UDP.
@@ -60,6 +60,7 @@ type ProxyFlags struct {
 
 // Add flags to the command.
 func (f *ProxyFlags) AddFlags(cmd *cobra.Command) {
+	//currently defaults to UDP
 	cmd.Flags().StringVarP(&f.ProxyProtocol, "proxy", "", defaultProxyProtocol,
 		"Proxy protocol. One of: "+strings.Join(availableProxy, "|"))
 
@@ -121,6 +122,12 @@ func (f *ProxyFlags) ToProxy() stream.Proxy {
 			log.Fatalf("could not open TCP proxy: %v\n", err)
 		}
 		return p
+	case "disabled":
+		p, err := stream.NewConnectionWithoutProxy()
+		if err != nil {
+			log.Fatalf("could not open connection: %v\n", err)
+		}
+		return p
 	}
 
 	log.Fatalf("unsupported proxy protocol: %v", protocol)

cmd/satellite/open_stream.go

@@ -82,6 +82,10 @@ func NewOpenStreamCommand() *cobra.Command {
 				DelayThreshold: correctOrderFlags.DelayThreshold,
 			}
 
+			if proxyFlags.ProxyProtocol == "disabled" && writeFileFlag.FileName == "" {
+				log.Println("No proxy or output file set. Streamed data will be discarded")
+			}
+
 			c := make(chan os.Signal)
 			signal.Notify(c, os.Interrupt)
 			defer close(c)

docs/stellar_satellite_open-stream.md

@@ -15,7 +15,7 @@ stellar satellite open-stream [satellite-id] [flags]
 ### Options
 
 ```
-      --accepted-framing strings   Framing type to receive. One of: IQ|IMAGE_PNG|IMAGE_JPEG|FREE_TEXT_UTF8|WATERFALL|BITSTREAM|AX25
+      --accepted-framing strings   Framing type to receive. One of: BITSTREAM|AX25|IQ|IMAGE_PNG|IMAGE_JPEG|FREE_TEXT_UTF8|WATERFALL
       --accepted-plan-id strings   Plan ID(s) to accept data from.
       --correct-order              When set to true, packets will be sorted by time_first_byte_received. This feature is alpha quality.
       --debug                      Output debug information. (default false)
@@ -24,7 +24,7 @@ stellar satellite open-stream [satellite-id] [flags]
       --listen-host string         Deprecated: use udp-listen-host instead.
       --listen-port uint16         Deprecated: use udp-listen-port instead.
       --output-file string         [Alpha feature] The file to write packets to. Creates file if it does not exist; appends to file if it already exists. (default none)
-      --proxy string               Proxy protocol. One of: udp|tcp (default "udp")
+      --proxy string               Proxy protocol. One of: udp|tcp|disabled (default "udp")
       --send-host string           Deprecated: use udp-send-host instead.
       --send-port uint16           Deprecated: use udp-send-port instead.
       --stats                      [Alpha feature] Output telemetry stats information and generate pass summaries (default false)

pkg/satellite/stream/disabled_proxy.go

@@ -0,0 +1,63 @@
+// Copyright © 2020 Infostellar, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package stream
+
+type noProxy struct {
+	stream     SatelliteStream
+	streamChan chan []byte
+}
+
+// Create a connection without using a proxy.
+func NewConnectionWithoutProxy() (Proxy, error) {
+	streamChan := make(chan []byte)
+
+	p := &noProxy{
+		streamChan: streamChan,
+	}
+
+	return p, nil
+}
+
+// Start listening for packets to send to the satellite and sending back received packets.
+func (p *noProxy) Start(o *SatelliteStreamOptions) (func(), error) {
+
+	var err error
+	var cleanup func()
+	p.stream, cleanup, err = OpenSatelliteStream(o, p.streamChan)
+	if err != nil {
+		return cleanup, err
+	}
+
+	go p.serve()
+
+	return cleanup, nil
+}
+
+func (p *noProxy) serve() {
+	for {
+		select {
+		case <-p.streamChan:
+		}
+	}
+}
+
+// Close the proxy.
+func (p *noProxy) Close() error {
+	// Close the API stream.
+	close(p.streamChan)
+	p.stream.Close()
+
+	return nil
+}