Class: Spikard::ServerConfig

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServerConfig

Returns a new instance of ServerConfig.

Parameters:



244
 
# File 'sig/types.rbs', line 244

def initialize: (?host: String, ?port: Integer, ?workers: Integer, ?enable_request_id: bool, ?max_body_size: Integer, ?request_timeout: Integer, ?compression: CompressionConfig, ?rate_limit: RateLimitConfig, ?jwt_auth: JwtConfig, ?api_key_auth: ApiKeyConfig, ?static_files: Array[StaticFilesConfig], ?graceful_shutdown: bool, ?shutdown_timeout: Integer, ?asyncapi: AsyncApiConfig, ?openapi: OpenApiConfig, ?jsonrpc: JsonRpcConfig, ?grpc: GrpcConfig, ?background_tasks: BackgroundTaskConfig, ?enable_http_trace: bool) -> void

Instance Attribute Details

#api_key_auth ⇒ ApiKeyConfig?

Returns the value of attribute api_key_auth.

Returns:



233
234
235
 
# File 'sig/types.rbs', line 233

def api_key_auth
  @api_key_auth
end

#asyncapi ⇒ AsyncApiConfig?

Returns the value of attribute asyncapi.

Returns:



237
238
239
 
# File 'sig/types.rbs', line 237

def asyncapi
  @asyncapi
end

#background_tasks ⇒ BackgroundTaskConfig?

Returns the value of attribute background_tasks.

Returns:



241
242
243
 
# File 'sig/types.rbs', line 241

def background_tasks
  @background_tasks
end

#compression ⇒ CompressionConfig?

Returns the value of attribute compression.

Returns:



230
231
232
 
# File 'sig/types.rbs', line 230

def compression
  @compression
end

#enable_http_trace ⇒ Boolean?

Returns the value of attribute enable_http_trace.

Returns:

  • (Boolean, nil) 


242
243
244
 
# File 'sig/types.rbs', line 242

def enable_http_trace
  @enable_http_trace
end

#enable_request_id ⇒ Boolean?

Returns the value of attribute enable_request_id.

Returns:

  • (Boolean, nil) 


227
228
229
 
# File 'sig/types.rbs', line 227

def enable_request_id
  @enable_request_id
end

#graceful_shutdown ⇒ Boolean?

Returns the value of attribute graceful_shutdown.

Returns:

  • (Boolean, nil) 


235
236
237
 
# File 'sig/types.rbs', line 235

def graceful_shutdown
  @graceful_shutdown
end

#grpc ⇒ GrpcConfig?

Returns the value of attribute grpc.

Returns:



240
241
242
 
# File 'sig/types.rbs', line 240

def grpc
  @grpc
end

#host ⇒ String?

Returns the value of attribute host.

Returns:

  • (String, nil) 


224
225
226
 
# File 'sig/types.rbs', line 224

def host
  @host
end

#jsonrpc ⇒ JsonRpcConfig?

Returns the value of attribute jsonrpc.

Returns:



239
240
241
 
# File 'sig/types.rbs', line 239

def jsonrpc
  @jsonrpc
end

#jwt_auth ⇒ JwtConfig?

Returns the value of attribute jwt_auth.

Returns:



232
233
234
 
# File 'sig/types.rbs', line 232

def jwt_auth
  @jwt_auth
end

#max_body_size ⇒ Integer?

Returns the value of attribute max_body_size.

Returns:

  • (Integer, nil) 


228
229
230
 
# File 'sig/types.rbs', line 228

def max_body_size
  @max_body_size
end

#openapi ⇒ OpenApiConfig?

Returns the value of attribute openapi.

Returns:



238
239
240
 
# File 'sig/types.rbs', line 238

def openapi
  @openapi
end

#port ⇒ Integer?

Returns the value of attribute port.

Returns:

  • (Integer, nil) 


225
226
227
 
# File 'sig/types.rbs', line 225

def port
  @port
end

#rate_limit ⇒ RateLimitConfig?

Returns the value of attribute rate_limit.

Returns:



231
232
233
 
# File 'sig/types.rbs', line 231

def rate_limit
  @rate_limit
end

#request_timeout ⇒ Integer?

Returns the value of attribute request_timeout.

Returns:

  • (Integer, nil) 


229
230
231
 
# File 'sig/types.rbs', line 229

def request_timeout
  @request_timeout
end

#shutdown_timeout ⇒ Integer?

Returns the value of attribute shutdown_timeout.

Returns:

  • (Integer, nil) 


236
237
238
 
# File 'sig/types.rbs', line 236

def shutdown_timeout
  @shutdown_timeout
end

#static_files ⇒ Array[StaticFilesConfig]?

Returns the value of attribute static_files.

Returns:



234
235
236
 
# File 'sig/types.rbs', line 234

def static_files
  @static_files
end

#workers ⇒ Integer?

Returns the value of attribute workers.

Returns:

  • (Integer, nil) 


226
227
228
 
# File 'sig/types.rbs', line 226

def workers
  @workers
end

Class Method Details

.default ⇒ ServerConfig

Returns:



245
 
# File 'sig/types.rbs', line 245

def self.default: () -> ServerConfig