Share this page
lrs_length_send
| Example: lrs_length_send | Sockets Functions |
Sends data of a specified length on a stream socket.
int lrs_length_send( char *socket_descriptor, char *buffer, int location_option, [char* locators], [char* additional_params], LrsLastArg );
| socket_descriptor | A descriptor identifying the socket. |
| buffer | A descriptor identifying the buffer to send. For details on editing the Windows Sockets Buffers, see How to View and Modify Windows Sockets Buffers under Windows Sockets Protocol in the VuGen User Guide. |
| location_option | The method with which to locate the field within the buffer that determines the length. NoOption - 0 OffsetSize - 1 LeftRightBoundaries - 2 LeftBoundarySize - 3 |
| locator | The values to enable location of the length field within the buffer. You can use parameterization for these values. For option 1, OffsetSize, use "Offset=xxx" (default=0) and "Size=xxx". For option 2, LeftRightBoundaries, specify "LB=xxx", "RB=xxx, and the optional "Ordinal=" and "Offset=xxx". For option 3, LeftBoundarySize, specify "Size=xxx", "LB=xxx", and the optional "Ordinal=" and "Offset=xxx". |
| additional_params | How the length value within the buffer is formatted and further calculations of the length: "Encoding=" - 0 for decimal (default), 1 for HEX "Order=" - 0 for by host (default), 1 by network order scheme "SubtractSize=" - 0 do not include the size of the data in its length (default), or 1, include the size of the data in its length. |
| LrsLastArg | A marker indicating the end of the parameter list. |
The lrs_length_send function writes data of a specified length from sock_descriptor into buffer. It is useful when sending parameterized data, where the length of data can be different each time the function is called. lrs_length_send saves you from having to calculate the length each time as Vugen will automatically write the correct length of the data into the field specified by the locator and location_option arguments.
Vugen inserts the length in the buffer itself. The user must be aware where the length value is placed within the buffer (unless the NoOption option is chosen) and its location is specified by the parameters location_option and locators. lrs_length_send first obtains the value of length (hereafter called length) and afterwards writes length number of bytes from the socket_descriptor into buffer.
The socket_descriptor and buffer parameters are identical to the first two parameters of lrs_send.
The location_option parameters:
NoOption- lrs_length_send will behave identically to lrs_send. That is, the amount of data to be send will not be limited to a specified length but by the socket buffer size.
OffsetSize- length takes up sizebytes and is placed offset bytes from the beginning of the buffer. The values for the offset and size are passed as locator parameters with the "Offset" and Size" identifiers (e.g., "Offset=6", "Size=4"). After locating the length fieldlrs_length_receive will write length number of bytes that directly follow it.The default value of "Offset" is zero.
LeftRightBoundaries - length is found between a left and right boundary. The values for both boundaries are passed as locator parameters using "LB" and "RB". The amount of data to write will be length number of bytes immediately following the right boundary. The locator parameters "Offset" and "Ordinal" may also be used.If the left or right boundary is a binary value, specify this by appending /BIN to the option indicator e.g.
"RB/BIN=\\x00\\x00\\x01\\x00\\x00\\x00"
LeftBoundarySize - length is located after a left boundary and takes up size bytes. The values for the left boundary and size are passed as locator parameters "LB" and "Size", respectively. The locator parameters "Offset" and "Ordinal" may also be used as well as the /BIN indicator option.
The locator parameters:
Locator parameters may be used in conjunction by passing them as separate string parameters to lrs_length_send e.g., "LB=LeftLeft ", "Size=1", "Offset=18".
Use the "Offset" locator (e.g., "Offset=4") with the OffsetSize location_option, where Offset specifies how many bytes from the beginning of the buffer lies the length field .Use "Offset" with the LeftRightBoundaries orLeftBoundarySize location_option where, to locate length, Offset number of bytes will be added to the left boundary. This is useful when there is always a specific number of bytes of unknown content following a known left boundary. For example, consider three characters, "ABC", that define the left boundary - if there are always 2 bytes of unknown content between "ABC" and length then pass "LB=ABC" and "Offset=2".
The "Ordinal" locator may be used with the LeftRightBoundaries or LeftBoundarySize location_option. It indicates that the length field begins after the ordinal instance of the left boundary. For example, if the left boundary, the string "ABC", appears many times in the buffer, then "Ordinal=2" specifies that you use the second instance of "ABC" to locating length.Note that "Ordinal" can be used in conjunction with "Offset". length lies Offset bytes following the Ordinal instance of the left boundary.
The additional_params parameters:
These parameters indicate in what format the length field will be found. They can also be used in conjunction and are passed as separate string parameters to lrs_length_send e.g., "Order=1", "Encoding=1".
Some length fields in a buffer include their own length in the total value. SubtractSize enables you to subtract the length of the field from the total to enable lrs_length_send to correctly write only the length of data.
Return Values
If this function fails, it returns NULL. If it succeeds, it returns a pointer to the converted buffer. You can also retrieve the converted buffer using lrs_get_user_buffer .
Parameterization
All locator and additional_params arguments can be parameterized.
