Main Page Modules Compound List File List Compound Members File Members Related Pages

# Network functions
[LibTDS API]

Functions for reading or writing from network. More...

## Defines

#define | TEMP_INIT(s) char temp[s]
#define | TEMP_FREE ;
#define | TEMP_SIZE sizeof(temp)

## Functions

unsigned char | tds_get_byte (TDSSOCKET *tds)
void | tds_unget_byte (TDSSOCKET *tds)
unsigned char | tds_peek (TDSSOCKET *tds)
TDS_SMALLINT | tds_get_smallint (TDSSOCKET *tds)
| Get an int16 from the server.
TDS_INT | tds_get_int (TDSSOCKET *tds)
| Get an int32 from the server.
int | tds_get_string (TDSSOCKET *tds, int string_len, char *dest, size_t dest_size)
| Fetch a string from the wire.
int | tds_get_char_data (TDSSOCKET *tds, char *row_buffer, size_t wire_size, TDSCOLINFO *curcol)
| Fetch character data the wire.
void * | tds_get_n (TDSSOCKET *tds, void *dest, int need)
| Get N bytes from the buffer and return them in the already allocated space given to us.
int | tds_get_size_by_type (int servertype)
| Return the number of bytes needed by specified type.
int | tds_read_packet (TDSSOCKET *tds)
| Read in one 'packet' from the server.
int | tds_put_n (TDSSOCKET *tds, const void *buf, int n)
int | tds_put_string (TDSSOCKET *tds, const char *s, int len)
| Output a string to wire automatic translate string to unicode if needed.
int | tds_put_buf (TDSSOCKET *tds, const unsigned char *buf, int dsize, int ssize)
int | tds_put_int8 (TDSSOCKET *tds, TDS_INT8 i)
int | tds_put_int (TDSSOCKET *tds, TDS_INT i)
int | tds_put_smallint (TDSSOCKET *tds, TDS_SMALLINT si)
int | tds_put_tinyint (TDSSOCKET *tds, TDS_TINYINT ti)
int | tds_put_byte (TDSSOCKET *tds, unsigned char c)
int | tds7_put_bcpcol (TDSSOCKET *tds, const BCP_COLINFO *bcpcol)
| Write a column's data to the TDS bcp stream.
int | tds_put_bulk_data (TDSSOCKET *tds, const unsigned char *buf, TDS_INT bufsize)
int | tds_init_write_buf (TDSSOCKET *tds)
int | tds_flush_packet (TDSSOCKET *tds)
| Flush packet to server.

## Detailed Description

Functions for reading or writing from network.

## Function Documentation

int tds7_put_bcpcol | ( | TDSSOCKET * | tds,
|  | const BCP_COLINFO * | bcpcol
| ) |

Write a column's data to the TDS bcp stream.

Data may be null.

Return values:

  TDS_SUCCEED | data written
  TDS_FAIL | must not write null data non-null column

Remarks:
  Most other write functions simply return zero.

int tds_flush_packet | ( | TDSSOCKET * | tds | ) |

Flush packet to server.

Returns:
  TDS_FAIL or TDS_SUCCEED

int tds_get_char_data | ( | TDSSOCKET * | tds,
|  | char * | row_buffer,
|  | size_t | wire_size,
|  | TDSCOLINFO * | curcol
| ) |

Fetch character data the wire.

Output is NOT null terminated. If iconv_info is not NULL, convert data accordingly.

Parameters:

  row_buffer | destination buffer in current_row. Can't be NULL
  wire_size | size to read from wire (in bytes)
  curcol | column information

Returns:
  TDS_SUCCEED or TDS_FAIL (probably memory error on text data)

Todo:
  put a TDSICONVINFO structure in every TDSCOLINFO

void* tds_get_n | ( | TDSSOCKET * | tds,
|  | void * | dest,
|  | int | need
| ) |

| Get N bytes from the buffer and return them in the already allocated space given to us. We ASSUME that the person calling this function has done the bounds checking for us since they know how many bytes they want here. dest of NULL means we just want to eat the bytes. (tetherow@nol.org)

int tds_get_string | ( | TDSSOCKET * | tds,
|  | int | string_len,
|  | char * | dest,
|  | size_t | dest_size
| ) |

Fetch a string from the wire.

Output string is NOT null terminated. If TDS version is 7 or 8 read unicode string and convert it. This function should be use to read server default encoding strings like columns name, table names, etc, not for data (use tds_get_char_data instead)

Returns:
  bytes written to dest

Parameters:

  tds | connection information
  string_len | length of string to read from wire (in server characters, bytes for tds4-tds5, ucs2 for tds7+)
  dest | destination buffer, if NULL string is read and discarded
  dest_size | destination buffer size, in bytes

int tds_put_string | ( | TDSSOCKET * | tds,
|  | const char * | s,
|  | int | len
| ) |

Output a string to wire automatic translate string to unicode if needed.

Parameters:

  s | string to write
  len | length of string in characters, or -1 for null terminated

int tds_read_packet | ( | TDSSOCKET * | tds | ) |

Read in one 'packet' from the server.

This is a wrapped outer packet of the protocol (they bundle result packets into chunks and wrap them at what appears to be 512 bytes regardless of how that breaks internal packet up. (tetherow@nol.org)

Returns:
  bytes read or -1 on failure