id
stringlengths
4
63
text
stringlengths
153
8.81M
SPI_cursor_move(3)
NAME SPI_cursor_move - move a cursor SYNOPSIS void SPI_cursor_move(Portal portal, bool forward, long count) DESCRIPTION SPI_cursor_move skips over some number of rows in a cursor. This is equivalent to a subset of the SQL command MOVE (see SPI_scroll_cursor_move for more functionality). ARGUMENTS Portal portal porta...
SPI_cursor_open(3)
NAME SPI_cursor_open - set up a cursor using a statement created with SPI_prepare SYNOPSIS Portal SPI_cursor_open(const char * name, SPIPlanPtr plan, Datum * values, const char * nulls, bool read_only) DESCRIPTION SPI_cursor_open sets up a cursor (internally, a portal) that will execute a statement prepared by SPI_pr...
SPI_cursor_open_with_args(3)
NAME SPI_cursor_open_with_args - set up a cursor using a query and parameters SYNOPSIS Portal SPI_cursor_open_with_args(const char *name, const char *command, int nargs, Oid *argtypes, Datum *values, const char *nulls, bool read_only, int cursorOptions) DESCRIPTION SPI_cursor_open_with_args sets up a cursor (internal...
SPI_cursor_open_with_paramlist(3)
NAME SPI_cursor_open_with_paramlist - set up a cursor using parameters SYNOPSIS Portal SPI_cursor_open_with_paramlist(const char *name, SPIPlanPtr plan, ParamListInfo params, bool read_only) DESCRIPTION SPI_cursor_open_with_paramlist sets up a cursor (internally, a portal) that will execute a statement prepared by SP...
SPI_cursor_parse_open(3)
NAME SPI_cursor_parse_open - set up a cursor using a query string and parameters SYNOPSIS Portal SPI_cursor_parse_open(const char *name, const char *command, const SPIParseOpenOptions * options) DESCRIPTION SPI_cursor_parse_open sets up a cursor (internally, a portal) that will execute the specified query string. Thi...
SPI_exec(3)
NAME SPI_exec - execute a read/write command SYNOPSIS int SPI_exec(const char * command, long count) DESCRIPTION SPI_exec is the same as SPI_execute, with the latter's read_only parameter always taken as false. ARGUMENTS const char * command string containing command to execute long count maximum ...
SPI_execp(3)
NAME SPI_execp - execute a statement in read/write mode SYNOPSIS int SPI_execp(SPIPlanPtr plan, Datum * values, const char * nulls, long count) DESCRIPTION SPI_execp is the same as SPI_execute_plan, with the latter's read_only parameter always taken as false. ARGUMENTS SPIPlanPtr plan prepared statement (returned by...
SPI_execute(3)
NAME SPI_execute - execute a command SYNOPSIS int SPI_execute(const char * command, bool read_only, long count) DESCRIPTION SPI_execute executes the specified SQL command for count rows. If read_only is true, the command must be read-only, and execution overhead is somewhat reduced. This function can only be ...
SPI_execute_extended(3)
NAME SPI_execute_extended - execute a command with out-of-line parameters SYNOPSIS int SPI_execute_extended(const char *command, const SPIExecuteOptions * options) DESCRIPTION SPI_execute_extended executes a command that might include references to externally supplied parameters. The command text refers to a paramete...
SPI_execute_plan(3)
NAME SPI_execute_plan - execute a statement prepared by SPI_prepare SYNOPSIS int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls, bool read_only, long count) DESCRIPTION SPI_execute_plan executes a statement prepared by SPI_prepare or one of its siblings. read_only and count have the same interp...
SPI_execute_plan_extended(3)
NAME SPI_execute_plan_extended - execute a statement prepared by SPI_prepare SYNOPSIS int SPI_execute_plan_extended(SPIPlanPtr plan, const SPIExecuteOptions * options) DESCRIPTION SPI_execute_plan_extended executes a statement prepared by SPI_prepare or one of its siblings. This function is equivalent to SPI_execute_...
SPI_execute_plan_with_paramlist(3)
NAME SPI_execute_plan_with_paramlist - execute a statement prepared by SPI_prepare SYNOPSIS int SPI_execute_plan_with_paramlist(SPIPlanPtr plan, ParamListInfo params, bool read_only, long count) DESCRIPTION SPI_execute_plan_with_paramlist executes a statement prepared by SPI_prepare. This function is equivalent to SP...
SPI_execute_with_args(3)
NAME SPI_execute_with_args - execute a command with out-of-line parameters SYNOPSIS int SPI_execute_with_args(const char *command, int nargs, Oid *argtypes, Datum *values, const char *nulls, bool read_only, long count) DESCRIPTION SPI_execute_with_args executes a command that might include references to externally su...
SPI_finish(3)
NAME SPI_finish - disconnect a C function from the SPI manager SYNOPSIS int SPI_finish(void) DESCRIPTION SPI_finish closes an existing connection to the SPI manager. You must call this function after completing the SPI operations needed during your C function's current invocation. You do not need to worry about makin...
SPI_fname(3)
NAME SPI_fname - determine the column name for the specified column number SYNOPSIS char * SPI_fname(TupleDesc rowdesc, int colnumber) DESCRIPTION SPI_fname returns a copy of the column name of the specified column. (You can use pfree to release the copy of the name when you don't need it anymore.) ARGUMENTS TupleDe...
SPI_fnumber(3)
NAME SPI_fnumber - determine the column number for the specified column name SYNOPSIS int SPI_fnumber(TupleDesc rowdesc, const char * colname) DESCRIPTION SPI_fnumber returns the column number for the column with the specified name. If colname refers to a system column (e.g., ctid) then the appropriate negati...
SPI_freeplan(3)
NAME SPI_freeplan - free a previously saved prepared statement SYNOPSIS int SPI_freeplan(SPIPlanPtr plan) DESCRIPTION SPI_freeplan releases a prepared statement previously returned by SPI_prepare or saved by SPI_keepplan or SPI_saveplan. ARGUMENTS SPIPlanPtr plan pointer to statement to free RETURN VALUE 0 on succe...
SPI_freetuple(3)
NAME SPI_freetuple - free a row allocated in the upper executor context SYNOPSIS void SPI_freetuple(HeapTuple row) DESCRIPTION SPI_freetuple frees a row previously allocated in the upper executor context. This function is no longer different from plain heap_freetuple. It's kept just for backward compatibility...
SPI_freetuptable(3)
NAME SPI_freetuptable - free a row set created by SPI_execute or a similar function SYNOPSIS void SPI_freetuptable(SPITupleTable * tuptable) DESCRIPTION SPI_freetuptable frees a row set created by a prior SPI command execution function, such as SPI_execute. Therefore, this function is often called with the global var...
SPI_getargcount(3)
NAME SPI_getargcount - return the number of arguments needed by a statement prepared by SPI_prepare SYNOPSIS int SPI_getargcount(SPIPlanPtr plan) DESCRIPTION SPI_getargcount returns the number of arguments needed to execute a statement prepared by SPI_prepare. ARGUMENTS SPIPlanPtr plan prepared statement (returned b...
SPI_getargtypeid(3)
NAME SPI_getargtypeid - return the data type OID for an argument of a statement prepared by SPI_prepare SYNOPSIS Oid SPI_getargtypeid(SPIPlanPtr plan, int argIndex) DESCRIPTION SPI_getargtypeid returns the OID representing the type for the argIndex'th argument of a statement prepared by SPI_prepare. First argument is...
SPI_getbinval(3)
NAME SPI_getbinval - return the binary value of the specified column SYNOPSIS Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber, bool * isnull) DESCRIPTION SPI_getbinval returns the value of the specified column in the internal form (as type Datum). This function does not allocate new space ...
SPI_getnspname(3)
NAME SPI_getnspname - return the namespace of the specified relation SYNOPSIS char * SPI_getnspname(Relation rel) DESCRIPTION SPI_getnspname returns a copy of the name of the namespace that the specified Relation belongs to. This is equivalent to the relation's schema. You should pfree the return value of this functi...
SPI_getrelname(3)
NAME SPI_getrelname - return the name of the specified relation SYNOPSIS char * SPI_getrelname(Relation rel) DESCRIPTION SPI_getrelname returns a copy of the name of the specified relation. (You can use pfree to release the copy of the name when you don't need it anymore.) ARGUMENTS Relation rel input relation RETU...
SPI_gettype(3)
NAME SPI_gettype - return the data type name of the specified column SYNOPSIS char * SPI_gettype(TupleDesc rowdesc, int colnumber) DESCRIPTION SPI_gettype returns a copy of the data type name of the specified column. (You can use pfree to release the copy of the name when you don't need it anymore.) ARGUMENTS TupleD...
SPI_gettypeid(3)
NAME SPI_gettypeid - return the data type OID of the specified column SYNOPSIS Oid SPI_gettypeid(TupleDesc rowdesc, int colnumber) DESCRIPTION SPI_gettypeid returns the OID of the data type of the specified column. ARGUMENTS TupleDesc rowdesc input row description int colnumber column number (coun...
SPI_getvalue(3)
NAME SPI_getvalue - return the string value of the specified column SYNOPSIS char * SPI_getvalue(HeapTuple row, TupleDesc rowdesc, int colnumber) DESCRIPTION SPI_getvalue returns the string representation of the value of the specified column. The result is returned in memory allocated using palloc. (You can u...
SPI_is_cursor_plan(3)
NAME SPI_is_cursor_plan - return true if a statement prepared by SPI_prepare can be used with SPI_cursor_open SYNOPSIS bool SPI_is_cursor_plan(SPIPlanPtr plan) DESCRIPTION SPI_is_cursor_plan returns true if a statement prepared by SPI_prepare can be passed as an argument to SPI_cursor_open, or false if that is not th...
SPI_keepplan(3)
NAME SPI_keepplan - save a prepared statement SYNOPSIS int SPI_keepplan(SPIPlanPtr plan) DESCRIPTION SPI_keepplan saves a passed statement (prepared by SPI_prepare) so that it will not be freed by SPI_finish nor by the transaction manager. This gives you the ability to reuse prepared statements in the subsequent invo...
SPI_modifytuple(3)
NAME SPI_modifytuple - create a row by replacing selected fields of a given row SYNOPSIS HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, int ncols, int * colnum, Datum * values, const char * nulls) DESCRIPTION SPI_modifytuple creates a new row by substituting new values for selected columns, copying the origin...
SPI_palloc(3)
NAME SPI_palloc - allocate memory in the upper executor context SYNOPSIS void * SPI_palloc(Size size) DESCRIPTION SPI_palloc allocates memory in the upper executor context. This function can only be used while connected to SPI. Otherwise, it throws an error. ARGUMENTS Size size size in bytes of storage to al...
SPI_pfree(3)
NAME SPI_pfree - free memory in the upper executor context SYNOPSIS void SPI_pfree(void * pointer) DESCRIPTION SPI_pfree frees memory previously allocated using SPI_palloc or SPI_repalloc. This function is no longer different from plain pfree. It's kept just for backward compatibility of existing code. ARGUM...
SPI_prepare(3)
NAME SPI_prepare - prepare a statement, without executing it yet SYNOPSIS SPIPlanPtr SPI_prepare(const char * command, int nargs, Oid * argtypes) DESCRIPTION SPI_prepare creates and returns a prepared statement for the specified command, but doesn't execute the command. The prepared statement can later be executed re...
SPI_prepare_cursor(3)
NAME SPI_prepare_cursor - prepare a statement, without executing it yet SYNOPSIS SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs, Oid * argtypes, int cursorOptions) DESCRIPTION SPI_prepare_cursor is identical to SPI_prepare, except that it also allows specification of the planner's “cursor options” para...
SPI_prepare_extended(3)
NAME SPI_prepare_extended - prepare a statement, without executing it yet SYNOPSIS SPIPlanPtr SPI_prepare_extended(const char * command, const SPIPrepareOptions * options) DESCRIPTION SPI_prepare_extended creates and returns a prepared statement for the specified command, but doesn't execute the command. This functio...
SPI_prepare_params(3)
NAME SPI_prepare_params - prepare a statement, without executing it yet SYNOPSIS SPIPlanPtr SPI_prepare_params(const char * command, ParserSetupHook parserSetup, void * parserSetupArg, int cursorOptions) DESCRIPTION SPI_prepare_params creates and returns a prepared statement for the specified command, but doesn't exe...
SPI_register_relation(3)
NAME SPI_register_relation - make an ephemeral named relation available by name in SPI queries SYNOPSIS int SPI_register_relation(EphemeralNamedRelation enr) DESCRIPTION SPI_register_relation makes an ephemeral named relation, with associated information, available to queries planned and executed through the current ...
SPI_register_trigger_data(3)
NAME SPI_register_trigger_data - make ephemeral trigger data available in SPI queries SYNOPSIS int SPI_register_trigger_data(TriggerData *tdata) DESCRIPTION SPI_register_trigger_data makes any ephemeral relations captured by a trigger available to queries planned and executed through the current SPI connection. Curre...
SPI_repalloc(3)
NAME SPI_repalloc - reallocate memory in the upper executor context SYNOPSIS void * SPI_repalloc(void * pointer, Size size) DESCRIPTION SPI_repalloc changes the size of a memory segment previously allocated using SPI_palloc. This function is no longer different from plain repalloc. It's kept just for backward...
SPI_result_code_string(3)
NAME SPI_result_code_string - return error code as string SYNOPSIS const char * SPI_result_code_string(int code); DESCRIPTION SPI_result_code_string returns a string representation of the result code returned by various SPI functions or stored in SPI_result. ARGUMENTS int code result code RETURN VALUE A string repr...
SPI_returntuple(3)
NAME SPI_returntuple - prepare to return a tuple as a Datum SYNOPSIS HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc) DESCRIPTION SPI_returntuple makes a copy of a row in the upper executor context, returning it in the form of a row type Datum. The returned pointer need only be converted to Datum via...
SPI_rollback(3)
NAME SPI_rollback, SPI_rollback_and_chain - abort the current transaction SYNOPSIS void SPI_rollback(void) void SPI_rollback_and_chain(void) DESCRIPTION SPI_rollback rolls back the current transaction. It is approximately equivalent to running the SQL command ROLLBACK. After the transaction is rolled back, a ...
SPI_rollback_and_chain(3)
NAME SPI_rollback, SPI_rollback_and_chain - abort the current transaction SYNOPSIS void SPI_rollback(void) void SPI_rollback_and_chain(void) DESCRIPTION SPI_rollback rolls back the current transaction. It is approximately equivalent to running the SQL command ROLLBACK. After the transaction is rolled back, a ...
SPI_saveplan(3)
NAME SPI_saveplan - save a prepared statement SYNOPSIS SPIPlanPtr SPI_saveplan(SPIPlanPtr plan) DESCRIPTION SPI_saveplan copies a passed statement (prepared by SPI_prepare) into memory that will not be freed by SPI_finish nor by the transaction manager, and returns a pointer to the copied statement. This gives you th...
SPI_scroll_cursor_fetch(3)
NAME SPI_scroll_cursor_fetch - fetch some rows from a cursor SYNOPSIS void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction, long count) DESCRIPTION SPI_scroll_cursor_fetch fetches some rows from a cursor. This is equivalent to the SQL command FETCH. ARGUMENTS Portal portal portal containing the curso...
SPI_scroll_cursor_move(3)
NAME SPI_scroll_cursor_move - move a cursor SYNOPSIS void SPI_scroll_cursor_move(Portal portal, FetchDirection direction, long count) DESCRIPTION SPI_scroll_cursor_move skips over some number of rows in a cursor. This is equivalent to the SQL command MOVE. ARGUMENTS Portal portal portal containing the cursor ...
SPI_start_transaction(3)
NAME SPI_start_transaction - obsolete function SYNOPSIS void SPI_start_transaction(void) DESCRIPTION SPI_start_transaction does nothing, and exists only for code compatibility with earlier PostgreSQL releases. It used to be required after calling SPI_commit or SPI_rollback, but now those functions start a new transac...
SPI_unregister_relation(3)
NAME SPI_unregister_relation - remove an ephemeral named relation from the registry SYNOPSIS int SPI_unregister_relation(const char * name) DESCRIPTION SPI_unregister_relation removes an ephemeral named relation from the registry for the current connection. ARGUMENTS const char * name the relation registry entry nam...
SRP_Calc_A.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_B.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_B_ex.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_client_key.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_client_key_ex.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_server_key.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_u.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_u_ex.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_x.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_Calc_x_ex.3ssl(3)
NAME SRP_Calc_server_key, SRP_Calc_A, SRP_Calc_B_ex, SRP_Calc_B, SRP_Calc_u_ex, SRP_Calc_u, SRP_Calc_x_ex, SRP_Calc_x, SRP_Calc_client_key_ex, SRP_Calc_client_key - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden ...
SRP_VBASE_add0_user.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_VBASE_free.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_VBASE_get1_by_user.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_VBASE_get_by_user.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_VBASE_init.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_VBASE_new.3ssl(3)
NAME SRP_VBASE_new, SRP_VBASE_free, SRP_VBASE_init, SRP_VBASE_add0_user, SRP_VBASE_get1_by_user, SRP_VBASE_get_by_user - Functions to create and manage a stack of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden en...
SRP_check_known_gN_param.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_create_verifier.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_create_verifier_BN.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_create_verifier_BN_ex.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_create_verifier_ex.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_get_default_gN.3ssl(3)
NAME SRP_create_verifier_ex, SRP_create_verifier, SRP_create_verifier_BN_ex, SRP_create_verifier_BN, SRP_check_known_gN_param, SRP_get_default_gN - SRP authentication primitives SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defin...
SRP_user_pwd_free.3ssl(3)
NAME SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a record of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPE...
SRP_user_pwd_new.3ssl(3)
NAME SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a record of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPE...
SRP_user_pwd_set0_sv.3ssl(3)
NAME SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a record of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPE...
SRP_user_pwd_set1_ids.3ssl(3)
NAME SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a record of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPE...
SRP_user_pwd_set_gN.3ssl(3)
NAME SRP_user_pwd_new, SRP_user_pwd_free, SRP_user_pwd_set1_ids, SRP_user_pwd_set_gN, SRP_user_pwd_set0_sv - Functions to create a record of SRP user verifier information SYNOPSIS #include <openssl/srp.h> The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPE...
SSAM_DEFINE_SYNC_REQUEST_CL_N(9)
NAME SSAM_DEFINE_SYNC_REQUEST_CL_N - Define synchronous client-device SAM request function with neither argument nor return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_CL_N (name , spec... ); ARGUMENTS name Name of the generated function. spec Specification (struct ssam_request_spec_md) defining th...
SSAM_DEFINE_SYNC_REQUEST_CL_R(9)
NAME SSAM_DEFINE_SYNC_REQUEST_CL_R - Define synchronous client-device SAM request function with return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_CL_R (name , rtype , spec... ); ARGUMENTS name Name of the generated function. rtype Type of the request's return value. spec Specificatio...
SSAM_DEFINE_SYNC_REQUEST_CL_W(9)
NAME SSAM_DEFINE_SYNC_REQUEST_CL_W - Define synchronous client-device SAM request function with argument. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_CL_W (name , atype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. spec Specification (struc...
SSAM_DEFINE_SYNC_REQUEST_CL_WR(9)
NAME SSAM_DEFINE_SYNC_REQUEST_CL_WR - Define synchronous client-device SAM request function with argument and return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_CL_WR (name , atype , rtype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. rtype...
SSAM_DEFINE_SYNC_REQUEST_MD_N(9)
NAME SSAM_DEFINE_SYNC_REQUEST_MD_N - Define synchronous multi-device SAM request function with neither argument nor return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_MD_N (name , spec... ); ARGUMENTS name Name of the generated function. spec Specification (struct ssam_request_spec_md) defining the...
SSAM_DEFINE_SYNC_REQUEST_MD_R(9)
NAME SSAM_DEFINE_SYNC_REQUEST_MD_R - Define synchronous multi-device SAM request function with return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_MD_R (name , rtype , spec... ); ARGUMENTS name Name of the generated function. rtype Type of the request's return value. spec Specification...
SSAM_DEFINE_SYNC_REQUEST_MD_W(9)
NAME SSAM_DEFINE_SYNC_REQUEST_MD_W - Define synchronous multi-device SAM request function with argument. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_MD_W (name , atype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. spec Specification (struct...
SSAM_DEFINE_SYNC_REQUEST_MD_WR(9)
NAME SSAM_DEFINE_SYNC_REQUEST_MD_WR - Define synchronous multi-device SAM request function with both argument and return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_MD_WR (name , atype , rtype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. r...
SSAM_DEFINE_SYNC_REQUEST_N(9)
NAME SSAM_DEFINE_SYNC_REQUEST_N - Define synchronous SAM request function with neither argument nor return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_N (name , spec... ); ARGUMENTS name Name of the generated function. spec Specification (struct ssam_request_spec) defining the request. DESCRIPTION...
SSAM_DEFINE_SYNC_REQUEST_R(9)
NAME SSAM_DEFINE_SYNC_REQUEST_R - Define synchronous SAM request function with return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_R (name , rtype , spec... ); ARGUMENTS name Name of the generated function. rtype Type of the request's return value. spec Specification (struct ssam_reque...
SSAM_DEFINE_SYNC_REQUEST_W(9)
NAME SSAM_DEFINE_SYNC_REQUEST_W - Define synchronous SAM request function with argument. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_W (name , atype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. spec Specification (struct ssam_request_spec)...
SSAM_DEFINE_SYNC_REQUEST_WR(9)
NAME SSAM_DEFINE_SYNC_REQUEST_WR - Define synchronous SAM request function with both argument and return value. SYNOPSIS SSAM_DEFINE_SYNC_REQUEST_WR (name , atype , rtype , spec... ); ARGUMENTS name Name of the generated function. atype Type of the request's argument. rtype Type of ...
SSAM_DEVICE(9)
NAME SSAM_DEVICE - Initialize a &struct ssam_device_id with the given parameters. SYNOPSIS SSAM_DEVICE (d , cat , tid , iid , fun ); ARGUMENTS d Domain of the device. cat Target category of the device. tid Target ID of the device. iid Instance ID of the device...
SSAM_EVENT_REGISTRY(9)
NAME SSAM_EVENT_REGISTRY - Define a new event registry. SYNOPSIS SSAM_EVENT_REGISTRY (tc , tid , cid_en , cid_dis ); ARGUMENTS tc Target category for the event registry requests. tid Target ID for the event registry requests. cid_en Command ID for the event-enable request. ...
SSAM_SDEV(9)
NAME SSAM_SDEV - Initialize a &struct ssam_device_id as physical SSH device with the given parameters. SYNOPSIS SSAM_SDEV (cat , tid , iid , fun ); ARGUMENTS cat Target category of the device. tid Target ID of the device. iid Instance ID of the device. fun Sub-f...
SSAM_VDEV(9)
NAME SSAM_VDEV - Initialize a &struct ssam_device_id as virtual device with the given parameters. SYNOPSIS SSAM_VDEV (cat , tid , iid , fun ); ARGUMENTS cat Target category of the device. tid Target ID of the device. iid Instance ID of the device. fun Sub-functi...
SSH_COMMAND_MESSAGE_LENGTH(9)
NAME SSH_COMMAND_MESSAGE_LENGTH - Compute length of SSH command message. SYNOPSIS SSH_COMMAND_MESSAGE_LENGTH (payload_size ); ARGUMENTS payload_size Length of the command payload. RETURN Returns the length of a SSH command message with command payload of specified size. SEE ALSO Kernel file ./include/linux/surfac...
SSH_MESSAGE_LENGTH(9)
NAME SSH_MESSAGE_LENGTH - Compute length of SSH message. SYNOPSIS SSH_MESSAGE_LENGTH (payload_size ); ARGUMENTS payload_size Length of the payload inside the SSH frame. RETURN Returns the length of a SSH message with payload of specified size. SEE ALSO Kernel file ./include/linux/surface_aggregator/serial_hub.h en...
SSH_MSGOFFSET_COMMAND(9)
NAME SSH_MSGOFFSET_COMMAND - Compute offset in SSH message to specified field in command. SYNOPSIS SSH_MSGOFFSET_COMMAND (field ); ARGUMENTS field The field for which the offset should be computed. RETURN Returns the offset of the specified struct ssh_command field in the raw SSH message data. Takes SYN bytes ...
SSH_MSGOFFSET_FRAME(9)
NAME SSH_MSGOFFSET_FRAME - Compute offset in SSH message to specified field in frame. SYNOPSIS SSH_MSGOFFSET_FRAME (field ); ARGUMENTS field The field for which the offset should be computed. RETURN Returns the offset of the specified struct ssh_frame field in the raw SSH message data as. Takes SYN bytes (u16)...
SSH_PACKET_PRIORITY(9)
NAME SSH_PACKET_PRIORITY - Compute packet priority from base priority and number of tries. SYNOPSIS SSH_PACKET_PRIORITY (base , try ); ARGUMENTS base The base priority as suffix of enum ssh_packet_base_priority, e.g. “FLUSH, DATA, ACK, or NAK“. try The number of tries (must be less than 16). ...
SSL_ACCEPT_CONNECTION_NO_BLOCK.3ssl(3)
NAME SSL_new_listener, SSL_new_listener_from, SSL_is_listener, SSL_get0_listener, SSL_listen, SSL_accept_connection, SSL_get_accept_connection_queue_len, SSL_new_from_listener, SSL_ACCEPT_CONNECTION_NO_BLOCK - SSL object interface for abstracted connection acceptance SYNOPSIS #include <openssl/ssl.h> SSL *SSL...
SSL_ACCEPT_STREAM_BIDI.3ssl(3)
NAME SSL_accept_stream, SSL_get_accept_stream_queue_len, SSL_ACCEPT_STREAM_NO_BLOCK, SSL_ACCEPT_STREAM_UNI, SSL_ACCEPT_STREAM_BIDI - accept an incoming QUIC stream from a QUIC peer SYNOPSIS #include <openssl/ssl.h> #define SSL_ACCEPT_STREAM_NO_BLOCK #define SSL_ACCEPT_STREAM_UNI #define SSL_AC...
SSL_ACCEPT_STREAM_NO_BLOCK.3ssl(3)
NAME SSL_accept_stream, SSL_get_accept_stream_queue_len, SSL_ACCEPT_STREAM_NO_BLOCK, SSL_ACCEPT_STREAM_UNI, SSL_ACCEPT_STREAM_BIDI - accept an incoming QUIC stream from a QUIC peer SYNOPSIS #include <openssl/ssl.h> #define SSL_ACCEPT_STREAM_NO_BLOCK #define SSL_ACCEPT_STREAM_UNI #define SSL_AC...
SSL_ACCEPT_STREAM_UNI.3ssl(3)
NAME SSL_accept_stream, SSL_get_accept_stream_queue_len, SSL_ACCEPT_STREAM_NO_BLOCK, SSL_ACCEPT_STREAM_UNI, SSL_ACCEPT_STREAM_BIDI - accept an incoming QUIC stream from a QUIC peer SYNOPSIS #include <openssl/ssl.h> #define SSL_ACCEPT_STREAM_NO_BLOCK #define SSL_ACCEPT_STREAM_UNI #define SSL_AC...