github.com/kaleido-io/firefly@v0.0.0-20210622132723-8b4b6aacb971/internal/wsclient/config.go (about)

     1  // Copyright © 2021 Kaleido, Inc.
     2  //
     3  // SPDX-License-Identifier: Apache-2.0
     4  //
     5  // Licensed under the Apache License, Version 2.0 (the "License");
     6  // you may not use this file except in compliance with the License.
     7  // You may obtain a copy of the License at
     8  //
     9  //     http://www.apache.org/licenses/LICENSE-2.0
    10  //
    11  // Unless required by applicable law or agreed to in writing, software
    12  // distributed under the License is distributed on an "AS IS" BASIS,
    13  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14  // See the License for the specific language governing permissions and
    15  // limitations under the License.
    16  
    17  package wsclient
    18  
    19  import (
    20  	"github.com/kaleido-io/firefly/internal/config"
    21  	"github.com/kaleido-io/firefly/internal/restclient"
    22  )
    23  
    24  const (
    25  	defaultIntialConnectAttempts = 5
    26  	defaultBufferSize            = "16Kb"
    27  )
    28  
    29  const (
    30  	// WSSpecificConfPrefix is the sub-section of the http config options that contains websocket specific config
    31  	WSSpecificConfPrefix = "ws"
    32  
    33  	// WSConfigKeyWriteBufferSize is the write buffer size
    34  	WSConfigKeyWriteBufferSize = "ws.writeBufferSize"
    35  	// WSConfigKeyReadBufferSize is the read buffer size
    36  	WSConfigKeyReadBufferSize = "ws.readBufferSize"
    37  	// WSConfigKeyInitialConnectAttempts sets how many times the websocket should attempt to connect on startup, before failing (after initial connection, retry is indefinite)
    38  	WSConfigKeyInitialConnectAttempts = "ws.initialConnectAttempts"
    39  	// WSConfigKeyPath if set will define the path to connect to - allows sharing of the same URL between HTTP and WebSocket connection info
    40  	WSConfigKeyPath = "ws.path"
    41  )
    42  
    43  // InitPrefix ensures the prefix is initialized for HTTP too, as WS and HTTP
    44  // can share the same tree of configuration (and all the HTTP options apply to the initial upgrade)
    45  func InitPrefix(prefix config.Prefix) {
    46  	restclient.InitPrefix(prefix)
    47  	prefix.AddKnownKey(WSConfigKeyWriteBufferSize, defaultBufferSize)
    48  	prefix.AddKnownKey(WSConfigKeyReadBufferSize, defaultBufferSize)
    49  	prefix.AddKnownKey(WSConfigKeyInitialConnectAttempts, defaultIntialConnectAttempts)
    50  	prefix.AddKnownKey(WSConfigKeyPath)
    51  }