EgretDoc
Back to Home
Location:system/aio.fastcgi

Module

Module documentation.

moduleaio.fastcgi

Classes

Classes and inheritance.

classaio.fastcgi::FastCgiResponse
@brief`FastCgiResponse` type.
@details`FastCgiResponse` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class FastCgiResponse {
    /*
    @brief `out` field.
classaio.fastcgi::FastCgiRequest
@brief`FastCgiRequest` type.
@details`FastCgiRequest` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class FastCgiRequest {
    /*
    @brief `params` field.

Functions

Free functions and class methods.

functionaio.fastcgi::version_1
Signaturefunc version_1() -> Int
func version_1() -> Int {
    return protocol.fastcgi.version_1();
}
@briefProvides the system library operation `version_1`.
@detailsExecutes the `version_1` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::begin_request_type
Signaturefunc begin_request_type() -> Int
func begin_request_type() -> Int {
    return protocol.fastcgi.begin_request_type();
}
@briefProvides the system library operation `begin_request_type`.
@detailsExecutes the `begin_request_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::abort_request_type
Signaturefunc abort_request_type() -> Int
func abort_request_type() -> Int {
    return protocol.fastcgi.abort_request_type();
}
@briefProvides the system library operation `abort_request_type`.
@detailsExecutes the `abort_request_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::end_request_type
Signaturefunc end_request_type() -> Int
func end_request_type() -> Int {
    return protocol.fastcgi.end_request_type();
}
@briefProvides the system library operation `end_request_type`.
@detailsExecutes the `end_request_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::params_type
Signaturefunc params_type() -> Int
func params_type() -> Int {
    return protocol.fastcgi.params_type();
}
@briefProvides the system library operation `params_type`.
@detailsExecutes the `params_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::stdin_type
Signaturefunc stdin_type() -> Int
func stdin_type() -> Int {
    return protocol.fastcgi.stdin_type();
}
@briefProvides the system library operation `stdin_type`.
@detailsExecutes the `stdin_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::stdout_type
Signaturefunc stdout_type() -> Int
func stdout_type() -> Int {
    return protocol.fastcgi.stdout_type();
}
@briefProvides the system library operation `stdout_type`.
@detailsExecutes the `stdout_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::stderr_type
Signaturefunc stderr_type() -> Int
func stderr_type() -> Int {
    return protocol.fastcgi.stderr_type();
}
@briefProvides the system library operation `stderr_type`.
@detailsExecutes the `stderr_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::data_type
Signaturefunc data_type() -> Int
func data_type() -> Int {
    return protocol.fastcgi.data_type();
}
@briefProvides the system library operation `data_type`.
@detailsExecutes the `data_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::get_values_type
Signaturefunc get_values_type() -> Int
func get_values_type() -> Int {
    return protocol.fastcgi.get_values_type();
}
@briefReads the state or data for `get_values_type`.
@detailsExecutes the `get_values_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::get_values_result_type
Signaturefunc get_values_result_type() -> Int
func get_values_result_type() -> Int {
    return protocol.fastcgi.get_values_result_type();
}
@briefReads the state or data for `get_values_result_type`.
@detailsExecutes the `get_values_result_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::unknown_type
Signaturefunc unknown_type() -> Int
func unknown_type() -> Int {
    return protocol.fastcgi.unknown_type();
}
@briefProvides the system library operation `unknown_type`.
@detailsExecutes the `unknown_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::responder_role
Signaturefunc responder_role() -> Int
func responder_role() -> Int {
    return protocol.fastcgi.responder_role();
}
@briefProvides the system library operation `responder_role`.
@detailsExecutes the `responder_role` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::authorizer_role
Signaturefunc authorizer_role() -> Int
func authorizer_role() -> Int {
    return protocol.fastcgi.authorizer_role();
}
@briefProvides the system library operation `authorizer_role`.
@detailsExecutes the `authorizer_role` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::filter_role
Signaturefunc filter_role() -> Int
func filter_role() -> Int {
    return protocol.fastcgi.filter_role();
}
@briefProvides the system library operation `filter_role`.
@detailsExecutes the `filter_role` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::request_complete
Signaturefunc request_complete() -> Int
func request_complete() -> Int {
    return protocol.fastcgi.request_complete();
}
@briefProvides the system library operation `request_complete`.
@detailsExecutes the `request_complete` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::cant_mpx_conn
Signaturefunc cant_mpx_conn() -> Int
func cant_mpx_conn() -> Int {
    return protocol.fastcgi.cant_mpx_conn();
}
@briefProvides the system library operation `cant_mpx_conn`.
@detailsExecutes the `cant_mpx_conn` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::overloaded
Signaturefunc overloaded() -> Int
func overloaded() -> Int {
    return protocol.fastcgi.overloaded();
}
@briefProvides the system library operation `overloaded`.
@detailsExecutes the `overloaded` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::unknown_role
Signaturefunc unknown_role() -> Int
func unknown_role() -> Int {
    return protocol.fastcgi.unknown_role();
}
@briefProvides the system library operation `unknown_role`.
@detailsExecutes the `unknown_role` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::default_request_id
Signaturefunc default_request_id() -> Int
func default_request_id() -> Int {
    return protocol.fastcgi.default_request_id();
}
@briefProvides the system library operation `default_request_id`.
@detailsExecutes the `default_request_id` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::default_timeout_ms
Signaturefunc default_timeout_ms() -> Int
func default_timeout_ms() -> Int {
    return protocol.fastcgi.default_timeout_ms();
}
@briefProvides the system library operation `default_timeout_ms`.
@detailsExecutes the `default_timeout_ms` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::max_content_len
Signaturefunc max_content_len() -> Int
func max_content_len() -> Int {
    return protocol.fastcgi.max_content_len();
}
@briefProvides the system library operation `max_content_len`.
@detailsExecutes the `max_content_len` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionaio.fastcgi::FastCgiResponse.init
Signaturefunc init(self: aio.fastcgi.FastCgiResponse) -> Void
    func init(self: aio.fastcgi.FastCgiResponse) -> Void {
        self.out = "";
        self.err = "";
@briefInitializes a `FastCgiResponse` instance.
@detailsEstablishes the initial field state for `FastCgiResponse` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionaio.fastcgi::FastCgiResponse.deinit
Signaturefunc deinit(self: aio.fastcgi.FastCgiResponse) -> Void
    func deinit(self: aio.fastcgi.FastCgiResponse) -> Void {
    }
}
@briefReleases fallback resources at the end of the `FastCgiResponse` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionaio.fastcgi::FastCgiRequest.init
Signaturefunc init(self: aio.fastcgi.FastCgiRequest) -> Void
    func init(self: aio.fastcgi.FastCgiRequest) -> Void {
        self.params = new collections.Map<String, String>();
        self.stdin_data = "";
@briefInitializes a `FastCgiRequest` instance.
@detailsEstablishes the initial field state for `FastCgiRequest` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionaio.fastcgi::FastCgiRequest.deinit
Signaturefunc deinit(self: aio.fastcgi.FastCgiRequest) -> Void
    func deinit(self: aio.fastcgi.FastCgiRequest) -> Void {
        _ = self.params.free();
    }
@briefReleases fallback resources at the end of the `FastCgiRequest` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionaio.fastcgi::FastCgiRequest.set_param
Signaturefunc set_param(self: aio.fastcgi.FastCgiRequest, key: String, val: String) -> Void
    func set_param(self: aio.fastcgi.FastCgiRequest, key: String, val: String) -> Void {
        _ = self.params.set(key, val);
        return;
@briefSets state or configuration with `FastCgiRequest.set_param`.
@detailsExecutes the `set_param` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
  • keyKey name.
  • valValue supplied by the caller for storage, comparison, encoding, or transmission.
@returnVoid
functionaio.fastcgi::make_params
Signaturefunc make_params(script_filename: String, request_method: String, query_string: String, content_type: String, content_length: Int) -> collections.Map<String, String>
func make_params(script_filename: String, request_method: String, query_string: String, content_type: String, content_length: Int) -> collections.Map<String, String> {
    return protocol.fastcgi.make_params(script_filename, request_method, query_string, content_type, content_length);
}
@briefProvides the system library operation `make_params`.
@detailsExecutes the `make_params` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • script_filenameFilesystem path of the script file executed by the FastCGI backend.
  • request_methodHTTP method name associated with the FastCGI or HTTP request.
  • query_stringRaw query string component included in a CGI, HTTP, or URL request.
  • content_typeMIME content type associated with the request or response body.
  • content_lengthSize or length value that limits how much data the operation processes.
@returnReturns the operation result as `collections.Map<String, String>`.

Variables

Class fields (var).

varaio.fastcgi::FastCgiResponse.out
TypeString
@brief`out` field.
@detailsHolds the `out` value for each `FastCgiResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var out: String;
    /*
    @brief `err` field.
varaio.fastcgi::FastCgiResponse.err
TypeString
@brief`err` field.
@detailsHolds the `err` value for each `FastCgiResponse` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var err: String;
    /*
    @brief `app_status` field.
varaio.fastcgi::FastCgiResponse.app_status
TypeInt
@brief`app_status` field.
@detailsHolds the `app_status` value for each `FastCgiResponse` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var app_status: Int;
    /*
    @brief `protocol_status` field.
varaio.fastcgi::FastCgiResponse.protocol_status
TypeInt
@brief`protocol_status` field.
@detailsHolds the `protocol_status` value for each `FastCgiResponse` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var protocol_status: Int;

    /*
varaio.fastcgi::FastCgiRequest.params
Typecollections.Map<String, String>
@brief`params` field.
@detailsHolds the `params` value for each `FastCgiRequest` instance. The field type is `collections.Map<String, String>`, and constructors and methods keep it synchronized with the object's runtime state.
    var params: collections.Map<String, String>;
    /*
    @brief `stdin_data` field.
varaio.fastcgi::FastCgiRequest.stdin_data
TypeString
@brief`stdin_data` field.
@detailsHolds the `stdin_data` value for each `FastCgiRequest` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
    var stdin_data: String;
    /*
    @brief `request_id` field.
varaio.fastcgi::FastCgiRequest.request_id
TypeInt
@brief`request_id` field.
@detailsHolds the `request_id` value for each `FastCgiRequest` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
    var request_id: Int;
    /*
    @brief `keep_conn` field.
varaio.fastcgi::FastCgiRequest.keep_conn
TypeBool
@brief`keep_conn` field.
@detailsHolds the `keep_conn` value for each `FastCgiRequest` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
    var keep_conn: Bool;
    /*
    @brief `timeout_ms` field.
varaio.fastcgi::FastCgiRequest.timeout_ms
TypeInt
@brief`timeout_ms` field.
@detailsStores the default timeout in milliseconds. The field type is `Int`, and it is maintained by the constructors and methods of `FastCgiRequest`.
    var timeout_ms: Int;

    /*