FreeTDS API
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Classes | Functions
Results processing

Handle tokens in packets. More...

Collaboration diagram for Results processing:

Classes

struct  namelist
 Holds list of names. More...
 

Functions

static void adjust_character_column_size (TDSSOCKET *tds, TDSCOLUMN *curcol)
 Adjust column size according to client's encoding. More...
 
int determine_adjusted_size (const TDSICONV *char_conv, int size)
 Allow for maximum possible size of converted data, while being careful about integer division truncation. More...
 
static TDSRET tds5_process_dyn_result2 (TDSSOCKET *tds)
 Process new TDS 5.0 token for describing output parameters. More...
 
static TDSRET tds5_process_optioncmd (TDSSOCKET *tds)
 Process option cmd results. More...
 
static TDSRET tds5_process_result (TDSSOCKET *tds)
 tds5_process_result() is the TDS 5.0 result set processing routine. More...
 
static TDSRET tds5_process_result2 (TDSSOCKET *tds)
 tds5_process_result2() is the new TDS 5.0 result set processing routine. More...
 
static int tds71_read_table_names (TDSSOCKET *tds, int remainder, struct namelist **p_head)
 Reads table names for TDS 7.1+. More...
 
static TDSRET tds7_get_data_info (TDSSOCKET *tds, TDSCOLUMN *curcol)
 Reads data information from wire. More...
 
static TDSRET tds7_process_compute_result (TDSSOCKET *tds)
 tds7_process_compute_result() processes compute result sets for TDS 7/8. More...
 
static TDSRET tds7_process_result (TDSSOCKET *tds)
 tds7_process_result() is the TDS 7.0 result set processing routine. More...
 
static int tds_alloc_get_string (TDSSOCKET *tds, char **string, size_t len)
 Reads a string from wire in a new allocated buffer. More...
 
static void tds_free_namelist (struct namelist *head)
 Frees list of names. More...
 
static TDSRET tds_get_data_info (TDSSOCKET *tds, TDSCOLUMN *curcol, int is_param)
 Reads data metadata from wire. More...
 
int tds_get_token_size (int marker)
 tds_get_token_size() returns the size of a fixed length token used by tds_process_cancel() to determine how to read past a token More...
 
TDSDYNAMICtds_lookup_dynamic (TDSCONNECTION *conn, const char *id)
 Finds a dynamic given string id. More...
 
static const char * tds_pr_op (int op)
 Returns string representation for a given operation. More...
 
static TDSRET tds_process_auth (TDSSOCKET *tds)
 Process authentication token. More...
 
TDSRET tds_process_cancel (TDSSOCKET *tds)
 
static TDSRET tds_process_col_fmt (TDSSOCKET *tds)
 tds_process_col_fmt() is the other half of result set processing under TDS 4.2. More...
 
static TDSRET tds_process_col_name (TDSSOCKET *tds)
 tds_process_col_name() is one half of the result set under TDS 4.2 it contains all the column names, a TDS_COLFMT_TOKEN should immediately follow this token with the datatype/size information This is a 4.2 only function More...
 
static TDSRET tds_process_colinfo (TDSSOCKET *tds, char **names, int num_names)
 Reads column information. More...
 
static TDSRET tds_process_compute (TDSSOCKET *tds)
 tds_process_compute() processes compute rows and places them in the row buffer. More...
 
static TDSRET tds_process_compute_names (TDSSOCKET *tds)
 tds_process_compute_names() processes compute result sets. More...
 
static TDSRET tds_process_compute_result (TDSSOCKET *tds)
 tds_process_compute_result() processes compute result sets. More...
 
static TDSRET tds_process_cursor_tokens (TDSSOCKET *tds)
 Reads cursor command results. More...
 
static TDSRET tds_process_default_tokens (TDSSOCKET *tds, int marker)
 tds_process_default_tokens() is a catch all function that is called to process tokens not known to other tds_process_* routines More...
 
static TDSRET tds_process_dyn_result (TDSSOCKET *tds)
 Process results from dynamic. More...
 
static TDSDYNAMICtds_process_dynamic (TDSSOCKET *tds)
 tds_process_dynamic() finds the element of the dyns array for the id More...
 
static TDSRET tds_process_end (TDSSOCKET *tds, int marker, int *flags_parm)
 tds_process_end() processes any of the DONE, DONEPROC, or DONEINPROC tokens. More...
 
static TDSRET tds_process_env_chg (TDSSOCKET *tds)
 tds_process_env_chg() when ever certain things change on the server, such as database, character set, language, or block size. More...
 
static TDSRET tds_process_featureextack (TDSSOCKET *tds)
 
static TDSRET tds_process_info (TDSSOCKET *tds, int marker)
 tds_process_info() is called for INFO, ERR, or EED tokens and is responsible for calling the CLI's message handling routine More...
 
TDSRET tds_process_login_tokens (TDSSOCKET *tds)
 tds_process_login_tokens() is called after sending the login packet to the server. More...
 
static TDSRET tds_process_nbcrow (TDSSOCKET *tds)
 tds_process_nbcrow() processes rows and places them in the row buffer.
 
static TDSRET tds_process_param_result (TDSSOCKET *tds, TDSPARAMINFO **pinfo)
 process output parameters of a stored procedure. More...
 
static TDSRET tds_process_param_result_tokens (TDSSOCKET *tds)
 Process parameters from networks. More...
 
static TDSRET tds_process_params_result_token (TDSSOCKET *tds)
 tds_process_params_result_token() processes params on TDS5. More...
 
static void tds_process_pending_closes (TDSSOCKET *tds)
 Attempt to close all deferred closes (dynamics and cursors). More...
 
static TDSRET tds_process_row (TDSSOCKET *tds)
 tds_process_row() processes rows and places them in the row buffer. More...
 
TDSRET tds_process_simple_query (TDSSOCKET *tds)
 Process results for simple query as "SET TEXTSIZE" or "USE dbname" If the statement returns results, beware they are discarded. More...
 
static TDSRET tds_process_tabname (TDSSOCKET *tds)
 Process list of table from network. More...
 
TDSRET tds_process_tokens (TDSSOCKET *tds, TDS_INT *result_type, int *done_flags, unsigned flag)
 process all streams. More...
 
const char * tds_prtype (int type)
 Returns string representation of the given type. More...
 
static int tds_read_namelist (TDSSOCKET *tds, int remainder, struct namelist **p_head, int large)
 Reads list of names (usually table names) More...
 
static const char * tds_token_name (unsigned char marker)
 Returns string representation for a given token type. More...
 

Detailed Description

Handle tokens in packets.

Many PDU (packets data unit) contain tokens. (like result description, rows, data, errors and many other).

Function Documentation

static void adjust_character_column_size ( TDSSOCKET tds,
TDSCOLUMN curcol 
)
static

Adjust column size according to client's encoding.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
curcolcolumn to adjust

Here is the call graph for this function:

Here is the caller graph for this function:

int determine_adjusted_size ( const TDSICONV char_conv,
int  size 
)

Allow for maximum possible size of converted data, while being careful about integer division truncation.

All character data pass through iconv. It doesn't matter if the server side is Unicode or not; even Latin1 text need conversion if, for example, the client is UTF-8.

Parameters
char_convconversion structure
sizeunconverted byte size
Returns
maximum size for converted string

Here is the caller graph for this function:

static TDSRET tds5_process_dyn_result2 ( TDSSOCKET tds)
static

Process new TDS 5.0 token for describing output parameters.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds5_process_optioncmd ( TDSSOCKET tds)
static

Process option cmd results.

This token is available only on TDS 5.0 (Sybase).

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds5_process_result ( TDSSOCKET tds)
static

tds5_process_result() is the TDS 5.0 result set processing routine.

It is responsible for populating the tds->res_info structure. This is a TDS 5.0 only function

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds5_process_result2 ( TDSSOCKET tds)
static

tds5_process_result2() is the new TDS 5.0 result set processing routine.

It is responsible for populating the tds->res_info structure. This is a TDS 5.0 only function

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static int tds71_read_table_names ( TDSSOCKET tds,
int  remainder,
struct namelist **  p_head 
)
static

Reads table names for TDS 7.1+.

TDS 7.1+ return table names as an array of names (so database.schema.owner.name as separate names)

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
remainderbytes left to read
p_headpointer to list head to return
Returns
number of element returned or -1 on error

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds7_get_data_info ( TDSSOCKET tds,
TDSCOLUMN curcol 
)
static

Reads data information from wire.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
curcolcolumn where to store information

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds7_process_compute_result ( TDSSOCKET tds)
static

tds7_process_compute_result() processes compute result sets for TDS 7/8.

They is are very similar to normal result sets.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds7_process_result ( TDSSOCKET tds)
static

tds7_process_result() is the TDS 7.0 result set processing routine.

It is responsible for populating the tds->res_info structure. This is a TDS 7.0 only function

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static int tds_alloc_get_string ( TDSSOCKET tds,
char **  string,
size_t  len 
)
static

Reads a string from wire in a new allocated buffer.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
stringoutput string
lenlength of string to read
Returns
0 for success, -1 on error.

Here is the call graph for this function:

Here is the caller graph for this function:

static void tds_free_namelist ( struct namelist head)
static

Frees list of names.

Parameters
headlist head to free

Here is the caller graph for this function:

static TDSRET tds_get_data_info ( TDSSOCKET tds,
TDSCOLUMN curcol,
int  is_param 
)
static

Reads data metadata from wire.

Parameters
tdsstate information for the socket and the TDS protocol
curcolcolumn where to store information
is_paramtrue if metadata are for a parameter (false for normal column)

Here is the call graph for this function:

Here is the caller graph for this function:

int tds_get_token_size ( int  marker)

tds_get_token_size() returns the size of a fixed length token used by tds_process_cancel() to determine how to read past a token

Parameters
markertoken type.
TDSDYNAMIC* tds_lookup_dynamic ( TDSCONNECTION conn,
const char *  id 
)

Finds a dynamic given string id.

Returns
dynamic or NULL is not found
Parameters
connstate information for the socket and the TDS protocol
iddynamic id to search

Here is the caller graph for this function:

static const char * tds_pr_op ( int  op)
static

Returns string representation for a given operation.

Parameters
opoperation code
Returns
string representation. Empty if not found.

Here is the caller graph for this function:

static TDSRET tds_process_auth ( TDSSOCKET tds)
static

Process authentication token.

This token is only TDS 7.0+.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

TDSRET tds_process_cancel ( TDSSOCKET tds)
Remarks
Process the incoming token stream until it finds an end token (DONE, DONEPROC, DONEINPROC) with the cancel flag set. At that point the connection should be ready to handle a new query.
Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_col_fmt ( TDSSOCKET tds)
static

tds_process_col_fmt() is the other half of result set processing under TDS 4.2.

It follows tds_process_col_name(). It contains all the column type and size information. This is a 4.2 only function

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_col_name ( TDSSOCKET tds)
static

tds_process_col_name() is one half of the result set under TDS 4.2 it contains all the column names, a TDS_COLFMT_TOKEN should immediately follow this token with the datatype/size information This is a 4.2 only function

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_colinfo ( TDSSOCKET tds,
char **  names,
int  num_names 
)
static

Reads column information.

This token is only TDS 4.2

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
[in]namestable names
[in]num_namesnumber of table names

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_compute ( TDSSOCKET tds)
static

tds_process_compute() processes compute rows and places them in the row buffer.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_compute_names ( TDSSOCKET tds)
static

tds_process_compute_names() processes compute result sets.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_compute_result ( TDSSOCKET tds)
static

tds_process_compute_result() processes compute result sets.

These functions need work but since they get little use, nobody has complained! It is very similar to normal result sets.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_cursor_tokens ( TDSSOCKET tds)
static

Reads cursor command results.

This contains status of cursors.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_default_tokens ( TDSSOCKET tds,
int  marker 
)
static

tds_process_default_tokens() is a catch all function that is called to process tokens not known to other tds_process_* routines

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
markerToken type

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_dyn_result ( TDSSOCKET tds)
static

Process results from dynamic.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSDYNAMIC * tds_process_dynamic ( TDSSOCKET tds)
static

tds_process_dynamic() finds the element of the dyns array for the id

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
Returns
allocated dynamic or NULL on failure.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_end ( TDSSOCKET tds,
int  marker,
int *  flags_parm 
)
static

tds_process_end() processes any of the DONE, DONEPROC, or DONEINPROC tokens.

Parameters
tdsstate information for the socket and the TDS protocol
markerTDS token number
flags_parmfilled with bit flags (see TDS_DONE_ constants). Is NULL nothing is returned

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_env_chg ( TDSSOCKET tds)
static

tds_process_env_chg() when ever certain things change on the server, such as database, character set, language, or block size.

A environment change message is generated There is no action taken currently, but certain functions at the CLI level that return the name of the current database will need to use this.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_info ( TDSSOCKET tds,
int  marker 
)
static

tds_process_info() is called for INFO, ERR, or EED tokens and is responsible for calling the CLI's message handling routine

Returns
TDS_SUCCESS if informational, TDS_FAIL if error.

Here is the call graph for this function:

Here is the caller graph for this function:

TDSRET tds_process_login_tokens ( TDSSOCKET tds)

tds_process_login_tokens() is called after sending the login packet to the server.

It returns the success or failure of the login dependent on the protocol version. 4.2 sends an ACK token only when successful, TDS 5.0 sends it always with a success byte within

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

static TDSRET tds_process_param_result ( TDSSOCKET tds,
TDSPARAMINFO **  pinfo 
)
static

process output parameters of a stored procedure.

This differs from regular row/compute results in that there is no total number of parameters given, they just show up singly.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
[out]pinfooutput parameter. Should point to a not allocated structure

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_param_result_tokens ( TDSSOCKET tds)
static

Process parameters from networks.

Read all consecutives paramaters, not a single one. Parameters are then stored in tds->param_info or tds->cur_dyn->res_info depending if we are reading cursor results or normal parameters.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_params_result_token ( TDSSOCKET tds)
static

tds_process_params_result_token() processes params on TDS5.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the caller graph for this function:

static void tds_process_pending_closes ( TDSSOCKET tds)
static

Attempt to close all deferred closes (dynamics and cursors).

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_row ( TDSSOCKET tds)
static

tds_process_row() processes rows and places them in the row buffer.

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

TDSRET tds_process_simple_query ( TDSSOCKET tds)

Process results for simple query as "SET TEXTSIZE" or "USE dbname" If the statement returns results, beware they are discarded.

This function was written to avoid direct calls to tds_process_default_tokens (which caused problems such as ignoring query errors). Results are read until idle state or severe failure (do not stop for statement failure).

Returns
see tds_process_tokens for results (TDS_NO_MORE_RESULTS is never returned)

Here is the call graph for this function:

Here is the caller graph for this function:

static TDSRET tds_process_tabname ( TDSSOCKET tds)
static

Process list of table from network.

This token is only TDS 4.2

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

Here is the caller graph for this function:

TDSRET tds_process_tokens ( TDSSOCKET tds,
TDS_INT *  result_type,
int *  done_flags,
unsigned  flag 
)

process all streams.

tds_process_tokens() is called after submitting a query with tds_submit_query() and is responsible for calling the routines to populate tds->res_info if appropriate (some query have no result sets)

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
result_typeA pointer to an integer variable which tds_process_tokens sets to indicate the current type of result.
Values that indicate command status
TDS_DONE_RESULTThe results of a command have been completely processed. This command returned no rows.
TDS_DONEPROC_RESULTThe results of a command have been completely processed. This command returned rows.
TDS_DONEINPROC_RESULTThe results of a command have been completely processed. This command returned rows.
Values that indicate results information is available
TDS_ROWFMT_RESULTRegular Data format information tds->res_info now contains the result details ; tds->current_results now points to that data
TDS_COMPUTEFMT_ RESULTCompute data format information tds->comp_info now contains the result data; tds->current_results now points to that data
TDS_DESCRIBE_RESULT
Values that indicate data is available
ValueMeaningInformation returned
TDS_ROW_RESULTRegular row results 1 or more rows of regular data can now be retrieved
TDS_COMPUTE_RESULTCompute row results A single row of compute data can now be retrieved
TDS_PARAM_RESULTReturn parameter results param_info or cur_dyn->params contain returned parameters
TDS_STATUS_RESULTStored procedure status results tds->ret_status contain the returned code
Parameters
done_flagsFlags contained in the TDS_DONE*_TOKEN readed
flagFlags to select token type to stop/return
Todo:
Complete TDS_DESCRIBE_RESULT description
Return values
TDS_SUCCESSif a result set is available for processing.
TDS_FAILon error.
TDS_NO_MORE_RESULTSif all results have been completely processed.
anythingreturned by one of the many functions it calls. :-(

Here is the call graph for this function:

Here is the caller graph for this function:

const char* tds_prtype ( int  type)

Returns string representation of the given type.

Parameters
typedata type
Returns
type as string. Empty if not found.

Here is the caller graph for this function:

static int tds_read_namelist ( TDSSOCKET tds,
int  remainder,
struct namelist **  p_head,
int  large 
)
static

Reads list of names (usually table names)

Parameters
tdsA pointer to the TDSSOCKET structure managing a client/server operation.
remainderbytes left to read
p_headlist head to return
largetrue if name length from network are 2 byte (usually 1)

Here is the call graph for this function:

Here is the caller graph for this function:

static const char * tds_token_name ( unsigned char  marker)
static

Returns string representation for a given token type.

Parameters
markertoken type
Returns
string representation. Empty if not token not valid.

Here is the caller graph for this function: