github.com/vescale/zgraph@v0.0.0-20230410094002-959c02d50f95/options.go (about)

     1  // Copyright 2022 zGraph Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package zgraph
    16  
    17  const defaultConcurrency = 512
    18  
    19  // Options contains some options which is used to customize the zGraph database
    20  // instance while instantiating zGraph.
    21  type Options struct {
    22  	// Concurrency is used to limit the max concurrent sessions count. The NewSession
    23  	// method will block if the current alive sessions count reach this limitation.
    24  	Concurrency int64
    25  }
    26  
    27  // SetDefaults sets the missing options into default value.
    28  func (opt *Options) SetDefaults() {
    29  	if opt.Concurrency <= 0 {
    30  		opt.Concurrency = defaultConcurrency
    31  	}
    32  }