Queue Record Fields

• Queue Record Field Descriptions
• Alphabetical Listing of Queue Record Fields
• cd_timeout
• completed_retries
• completed_time
• control
• csid
• curr
• duration
• fn_cover
• fn_received
• fn_send
• header
• items_received
• items_sent
• line_noise
• list_type
• message_speed
• modem_id
• next
• notify
• nsf_field
• nsf_length
• number_calls
• operation
• phone_no
• prev
• priority_level
• protocol
• rate
• received_csid
• received_filetype
• received_nsf
• received_nsf_length
• record_control
• retry_counter
• retry_delay
• retry_end_time
• retry_strategy
• security
• signal_quality
• signal_strength
• source_type
• status
• submission_retries
• submission_time
• time
• transmit_control
• user_id

This section summarizes all of the queue record fields. It also provides an overview table and an alphabetic listing of the queue record fields with a description of their parameters.

Queue Record Field Descriptions

Table 15 provides a synopsis of the queue record fields.

NOTES:

1. Only a few fields need to be changed from the default values set by gfqClearRec( ).

2. All queue record fields which contain filenames must conform to the MS-DOS naming convention (eight characters separated by a dot, and then followed by a three-character extension).

Table 15. Summary of Fields in the Queue Record

Field	Size in Bytes	Data Types	Use
cd_timeout	2	GFQINT	Optional
completed_retries	2	GFQINT	Managed by GDK1
completed_time	4	GFQTIME	Managed by GDK1
control	2	GFQINT	Optional
csid	20 + 23	GFQBYTE	Optional
curr	4	GFQOFFSET	Managed by the libraries2
duration	2	GFQINT	Managed by GDK1
fn_cover	64 + 23	GFQBYTE	Optional
fn_received	64 + 23	GFQBYTE	Managed by GDK1
fn_send	64 + 23	GFQBYTE	Required (for sending)
header	20	GFQBYTE	Optional
items_received	2	GFQINT	Managed by GDK1
items_sent	2	GFQINT	Managed by GDK1
line_noise	2	GFQINT	Managed by GDK1
list_type	2	GFQINT	Managed by GDK1
message_speed	2	GFQINT	Managed by GDK1
modem_id	32+23	GFQBYTE	Optional
next	4	GFQOFFSET	Managed by the libraries2
notify	2	GFQINT	Managed by GDK1
nsf_field	32+23	GFQBYTE	Optional
nsf_length	2	GFQINT	Optional
number_calls	2	GFQINT	Optional
operation	2	GFQINT	Required
phone_no	20+23	GFQBYTE	Required (for sending), with call control
prev	4	GFQOFFSET	Managed by the libraries2
priority_level	2	GFQINT	Optional
protocol	2	GFQINT	Optional
rate	2	GFQINT	Optional
received_csid	20+23	GFQBYTE	Managed by GDK1
received_filetype	2	GFQINT	Managed by GDK1
received_nsf	32+23	GFQBYTE	Managed by GDK1
received_nsf_length	2	GFQINT	Managed by GDK1
record_control	2	GFQINT	Managed by GDK1
retry_counter	2	GFQINT	Optional
retry_delay	2	GFQINT	Optional
retry_end_time	4	GFQTIME	Optional
retry_strategy	2	GFQINT	Optional
security	4	GFQLONG	Optional
signal_quality	2	GFQINT	Managed by GDK1
signal_strength	2	GFQINT	Managed by GDK1
source_type	2	GFQINT	Optional
status	2	GFQINT	Managed by GDK1
submission_retries	2	GFQINT	Managed by GDK1
submission_time	4	GFQTIME	Managed by GDK1
time	4	GFQTIME	Optional
transmit_control	2	GFQINT	Optional
user_id	32+23	GFQBYTE	Optional

1 This field is filled in by the firmware after it processes the job. However, it may also be read from or written to by the GDK functions.

2 Both the firmware and the GDK functions manage the values in these fields, and you should not write directly to them.

3 Two bytes are used for terminating null characters for the string.

Alphabetical Listing of Queue Record Fields

The field descriptions are presented in the format shown in Table 16.

Table 16. Queue Record Field Description Formats

Function Name
DATA TYPE	The GDK data type description.
DESCRIPTION	An overview of the purpose of the field.
VALUE	Indicates the values required by the field.
USAGE	Provides an example of how to use this field in the GDK.
SEE ALSO	Refers to other queue record fields that contain additional or related information.

cd_timeout

DATA TYPE	GFQINT
DESCRIPTION	This field specifies the number of seconds to wait after dialing for answer-tone carrier detect. It cannot have a value of zero; the default is 30 seconds. On overseas calls, the connect time may be 60 to 90 seconds. Local calls might connect in 10 seconds.
VALUE	Positive integers to 32767.
USAGE	qrec->cd_timeout = 45;

completed_retries

DATA TYPE	GFQINT
DESCRIPTION	This field contains the number of completed retries and is managed by GDK firmware. For example, if the submission_retries is 3 and the retry_counter is 2, the completed_retries value is 1.
VALUE	Positive integers to 32767.
USAGE	attempts = qrec->completed_retries;

completed_time

DATA TYPE	GFQTIME
DESCRIPTION	This field tells when a record was completed and posted to a list. For example, after a record in the Pending List has been processed, it is posted to the Sent List and the completed_time is recorded in seconds. It is managed by GDK firmware.
VALUE	Positive long integer.
USAGE	ptr = ctime(&(qrec->completed_time));

control

DATA TYPE	GFQINT
DESCRIPTION	This field is used for Answer & Send, Answer & Receive, and Answer Default records only. A record waits for the phone to ring for the specified amount of time before it expires with a status code of 3033. The record is posted to the queue or application notification pipe after the specified time.
	The value is given in seconds; zero can be used. The default is 60.
VALUE	Positive integers to 32767.
USAGE	qrec->control = 20;

csid

DATA TYPE	GFQBYTE[GFQCSID_SIZE]
DESCRIPTION	This field is transmitted as the Customer Subscriber Identification (CSID) number during T.30-protocol handshaking. Usually, it contains the telephone number of the station or installation. It holds a maximum of 20 characters, or it can be empty. If the CSID field has spaces, it remains blank. Writing more than 20 characters to this field may produce unexpected results.
	If the CSID field is null and does not have spaces, the CSID from the user's configuration file corresponding to the fax channel processing the record is placed into the field.
	PTT administrations in some countries may restrict characters in this field to the numbers 0 through 9 and the plus (+).
VALUE	Up to 20 alphanumeric characters.
USAGE	strcpy (qrec->csid,"408-744-1549");

curr

DATA TYPE	GFQOFFSET
DESCRIPTION	This field contains a pointer to the current queue record in a linked list, and is managed by GDK firmware. When a queue record is inserted into the Queue File, the current record pointer is "assigned."
VALUE	Positive integer.
USAGE	This field is managed by GDK software and should not be modified by user programs.

duration

DATA TYPE	GFQINT
DESCRIPTION	This field can be used to determine the length of time it took to complete a phone call. It records the number of seconds of phone-connect time used for transmission or reception. In a Dial-and-Send-type operation, the timer starts at the end of the answer tone. This field is managed by the GDK communication programs.
VALUE	Positive integers to 32767.
USAGE	phone_time = qrec->duration;

fn_cover

DATA TYPE	GFQBYTE[GFQFILENAME_SIZE]
DESCRIPTION	This 64-byte field contains the name of the file comprising the cover page, if desired. It must be used in conjunction with the field (transmit_control |= GFQUSE_COVERSHEET).
VALUE	A character array of type GFQFILENAME_SIZE; always a full path to the cover-page file.
USAGE	strcpy (qrec->fn_cover,"c:\\fax\\cover.tif");
SEE ALSO	transmit_control

fn_received

DATA TYPE	GFQBYTE[GFQFILENAME_SIZE]
DESCRIPTION	This field contains the filename of a received fax file. The filename can be up to 64 bytes in length.
	The communication program initializes this field after the fax is received. A default filename is given to received transmissions - "f001p001.tif," in which the numerals increment with the transmission and page numbers.
	The first character indicates the fax channel that received the file. The first group of digits is a "call number," which provides a unique number for the fax. The character "p" refers to page, and the second group of digits indicates the page number of the fax.
	The default filename can be changed when a queue record is submitted with an Answer-operation parameter and by filling in this field. It may also be changed by using the GFXRECVPATH command. However, the first character always represents the fax channel that received the fax.
	The type of file it contains is indicated in the received_filetype field. Usually, the received_filetype is GFQSINGLE_DOC; however, for file transfer, the fn_received field generates a received_filetype of GFQLIST_OF_DOCS.
	If file transfer is used, the received filename is a list of files in the format xxxxXFER. FLS. This list contains the name of the file that was received, which is the same as the original sent filename (as long as the DOS xxxxxxxx.yyy format is observed and the filename does not already exist on the target drive). The "f001p001" filenaming style is used if the sent filename already exists; the original filename is included in parentheses next to the filename that was written in the list.
	For example, A001XFER.FLS could contain: TEST.TXT A001P001.TIF (TEST.PCX)
VALUE	A character array of type [GFQFILENAME_SIZE];.
USAGE	strcpy (qrec->fn_received, "c:\\fax\\f001p001.tif");
SEE ALSO	received_filetype

fn_send

DATA TYPE	GFQBYTE[GFQFILENAME_SIZE]
DESCRIPTION	This field, which can be up to 64 bytes in length, contains the name of a file to be sent.
	The type of file to be sent should be put in the source_type field. If it is a single file or a sequence of pages in the GDK filename format F001P001.TIF, the source_type is GFQSINGLE_DOC. If it is a list of files, the source_type is GFQLIST_OF_DOCS. A list of files must be an ASCII file, with every line containing a path to a file to send. Each line must be separated by a <CR><LF>.
VALUE	A character array of type [GFQFILENAME_SIZE];.
USAGE	strcpy (qrec->fn_send, "c:\\fax\\f001p001.tif");
SEE ALSO	source_type

header

DATA TYPE	GFQBYTE[GFQCSID_SIZE]
DESCRIPTION	This field contains the text that is included in a header, which is printed at the top of each sent fax. It is limited to 20 alphanumeric characters, but also can be empty. This field must be used in conjunction with (transmit_control |= GFQUSE_HEADER). The following is the default format of the header line on the printed page:
	date & time calling CSID -> called CSID text page # The information in this field fills the "text" field in the header file.
VALUE	A character array of type [GFQCSID_SIZE].
USAGE	strcpy (qrec->header,"Fax from GDK");
SEE ALSO	transmit_control

items_received

DATA TYPE	GFQINT
DESCRIPTION	This field contains the number of pages or files correctly received. If nothing is received because of an error, this field contains zero.
VALUE	Positive integers to 32767.
USAGE	number_pages = qrec->items_received;

items_sent

DATA TYPE	GFQINT
DESCRIPTION	This field contains the number of pages or files actually sent during the transmission, and it is managed by GDK firmware. If nothing is sent because of an error, this field contains zero.
VALUE	Positive integers to 32767.
USAGE	number_pages = qrec->items_sent;

line_noise

DATA TYPE	GFQINT
DESCRIPTION	The line noise, which is measured by the modem during quiet periods of the handshaking process, is recorded here. It is filled by GDK firmware when a message is received. This field is useful for determining if a failure in transmission is due to line problems.
VALUE	See Table 17.
USAGE	noise = qrec->line_noise

Table 17. Values Reported in line_noise

Value	dBm	Meaning
18	-65	Extremely quiet
50	-60	Very quiet
135	-55	Quiet
461	-50	Acceptable
1390	-45	Noisy
2300	-40	Unusable

list_type

DATA TYPE	GFQINT
DESCRIPTION	This field indicates the list to which a queue record belongs; it is managed by GDK firmware.
VALUE	See Table 18.
USAGE	if (qrec->list_type == GFQPEND_LIST)
	printf ("Pending Log");

Table 18. list_types in the Queue Record

Mnemonic	Meaning
GFQPEND_LIST	Pending List
GFQRECV_LIST	Received List
GFQSENT_LIST	Sent List
GFQCONV_LIST	Conversion List
GFQCTRL_LIST	Control List
GFQCPST_LIST	Control Done List
GFQFREE_LIST	Free (deleted) Records
GFQALL_LISTS	All Lists

message_speed

DATA TYPE	GFQINT
DESCRIPTION	This field records the transmission rate in bits per second (BPS) during transmission or reception. It is managed by GDK firmware.
VALUE	14400, 12000, 9600, 7200, 4800, and 2400 bps or GFQMAX_RATE for maximum default rate.
USAGE	speed = qrec->message_speed;

modem_id

DATA TYPE	GFQBYTE[GFQUSER_FIELD_SIZE]
DESCRIPTION	This 32-byte field is used for a multiple-fax channel chassis. It holds a string in the form "GFAXx.yy," where "x" represents the chassis number and "yy" is the channel number. (For more than nine channels, numbers in the form of "01," and so on, should be used.) This string should match the one used with the channel command in the ChannelID key in the registry file. When a queue record is submitted, the modem_id indicates the channel to which the task should be assigned. If this field is empty, the task goes to the first available channel.
VALUE	A character array of size [GFQUSER_FIELD_SIZE].
USAGE	strcpy (qrec->modem_id,"GFAX1.01"); strcpy (qrec->modem_id,"GFAX1.10");

next

DATA TYPE	GFQOFFSET
DESCRIPTION	This field contains a pointer to the next queue record in a linked list and is managed by GDK firmware. The last record in a linked list contains NULL.
VALUE	Positive integer.
USAGE	This field is managed by GDK software and should not be modified by user programs.

notify

DATA TYPE	GFQINT
DESCRIPTION	This field is evaluated by gfqClearReq( ); otherwise, it is unused. If your application writes to this field, it is not evaluated.
VALUE	None.
USAGE	This field is managed by the GDK software and should not be modified by user programs.

nsf_field

DATA TYPE	GFQBYTE[GFQUSER_FIELD_SIZE]
DESCRIPTION	This is the non-standard-facilities (NSF) field to be transmitted during T.30 handshaking. It can hold up to 32 bytes and is reserved for facsimile machines that support NSF.
	The ITU specifies that the first octet of the NSF/NSS/NSC frame must contain an ITU country code. The next two octets contain a provider code. The GDK provider code is 0x00,0x64.
VALUE	A character array of size [GFQUSER_FIELD_SIZE].
USAGE	qrec->nsf_field[0] = 0xAE;
SEE ALSO	nsf_length

nsf_length

DATA TYPE	GFQINT
DESCRIPTION	This field contains the number of bytes to be transmitted in the non-standard-facilities (NSF) field. It is sent to facsimile machines that support NSF.
VALUE	Positive integer of size 0 to GFQUSER_FIELD_SIZE.
USAGE	qrec->nsf_length = 20;
SEE ALSO	nsf_field

number_calls

DATA TYPE	GFQINT
DESCRIPTION	This field specifies the number of dial attempts to be made for each "retry." For example, if number_calls is equal to 3 for a queue record with 3 retries, the board will attempt to dial up to 9 times. If this field is not specified when a queue record is submitted, the default is 1.
VALUE	Positive integers to 32767.
USAGE	qrec->number_calls = 3;

operation

DATA TYPE	GFQINT
DESCRIPTION	When a record is submitted, this field must specify the operation to be performed. The operation tells the on-board software how to process a queue record.
VALUE	See Table 19.
USAGE	qrec->operation = GFQDIAL_SEND;

Table 19. Queue-Record Operations

Operation	Transaction	Send DIS	Wait for DIS
DIAL	Send		GFQDIAL_SEND
	Receive		GFQDIAL_RECEIVE
	Both		GFQDIAL_SEND_ RECEIVE
ANSWER	Send	GFQANSWER_SEND
	Receive	GFQANSWER_RECEIVE
	Both	GFQANSWER_RECEIVE_SEND
IMMEDIATE	Either	GFQANSWER_ IMMEDIATELY

phone_no

DATA TYPE	GFQBYTE[GFQCSID_SIZE]
DESCRIPTION	This field contains the telephone number to be dialed. It is limited to 20 characters (Table 20); no spaces are permitted. Characters such as "-", "(", and ")" count toward the 20-character limit, but are not evaluated.
	For additional dialing features, see the Routing section in Chapter 2.
	For dial strings with more than 20 digits, put the dial string into an ASCII file. The first character of the phone_no field is checked for the character "@." If an "@" is found, the remainder of the field (up to the first white space) is used as the name of the file from which the phone digits are to be read. The file to be used must be a fully-qualified path name. If the file specified cannot be found, or if it appears to be a non-ASCII file, the call is terminated with no retries. If the characters "P" or "T" are used, the modem changes to pulse or tone, respectively.
VALUE	A character array of size [GFQCSID_SIZE]. See Table 20.
USAGE	strcpy (qrec->phone_no,"408-744-1549").

Table 20. Characters in phone_no Field

Character(s)	Meaning
0 through 9	Phone numbers and access numbers
A through D	Phone numbers and access numbers
, (comma)	1.5-second pause
; (semicolon)	15-second wait for second dial tone
P	Pulse dialing
T	Tone dialing (default)
!	Flash-hook signal
#	Notifies international operator that the dialing sequence is finished
*	PBX-specific information

prev

DATA TYPE	GFQOFFSET
DESCRIPTION	This field contains a pointer to the previous queue record in a linked list. It is managed by GDK firmware. The first record contains NULL.
VALUE	Any positive integer.
USAGE	This field is managed by the GDK software and should not be modified by user programs.

priority_level

DATA TYPE	GFQINT
DESCRIPTION	The records in the Queue File are sorted first by date and time stamp (specified in the time data field), then by priority, then processed sequentially. Although records may be inserted non-sequentially, those submitted with the same date and time stamp are processed in the order of submission, unless priority is specified. Records with the priority date and time specified are processed first. Zero is the lowest priority; 32767 is the highest. The default is zero.
VALUE	Positive integers to 32767.
USAGE	qrec->priority_level = 99;

protocol

DATA TYPE	GFQINT
DESCRIPTION	Two modes of communication are available on CP Fax Series boards: sending an image file to a fax machine (GFQT30_PROTOCOL) and sending a data file. GFQT30_PROTOCOL is the default; it should be changed only if file-transfer mode is desired.The method used for data transfer is GFQBFTS BFT T.434 protocol. To use BFT, additional configuration commands must be placed in the registry. See the GFXFAXCONTROL 1020.
VALUE	GFQT30_PROTOCOL, GFQFILE_TRANSFER, GFQBFT
USAGE	qrec->protocol = GFQBFT;

rate

DATA TYPE	GFQINT
DESCRIPTION	This field is used to initialize the rate of transmission in bits per second (bps). If it is set to GFQMAX_RATE, the message is to be sent at the highest rate possible. Change the value only if a slower rate is required; for example, when a phone line is known to have poor quality.
VALUE	GFQMAX_RATE, 14400, 12000, 9600, 7200, 4800, and 2400 bps.
USAGE	qrec->rate = 4800;

received_csid

DATA TYPE	GFQBYTE[GFQCSID_SIZE]
DESCRIPTION	This field records the Customer Subscriber Identification (CSID) number of the remote machine. It is up to 20 characters long, can contain any alphanumeric character, and is managed by GDK firmware.
VALUE	A character array of size [GFQCSID_SIZE].
USAGE	strcpy (station_id,qrec->received_csid);

received_filetype

DATA TYPE	GFQINT
DESCRIPTION	This field contains a description of the file named in fn_received. When a transmission is received, it is used to indicate whether the operation involves a single fax, a list of files, or a file transfer. The field is managed by GDK firmware.
VALUE	GFQSINGLE_DOC or GFQLIST_OF_DOCS.
USAGE	if (qrec->received_filetype == GFQLIST_OF_DOCS) printf ("List of files was received.\n")
SEE ALSO	fn_received

received_nsf

DATA TYPE	GFQBYTE[GFQUSER_FIELD_SIZE]
DESCRIPTION	This 32-byte field contains the value of the non-standard-facilities (NSF) field received from the sending facsimile machine. It is managed by GDK firmware.
VALUE	A character array of type [GFQUSER_FIELD_SIZE].
USAGE	for (i = 0; i < qrec->received_nsf_length; i++) printf ("%02x", qrec->received_nsf);
SEE ALSO	received_nsf_length

received_nsf_length

DATA TYPE	GFQINT
DESCRIPTION	This field contains the length of the non-standard-facilities (NSF) field that was received. It is reserved for communication with facsimile machines that support NSF. It is managed by GDK firmware.
VALUE	Integers from 0 to GFQUSER_FIELD_SIZE.
USAGE	This field is managed by the GDK software and should not be modified by user programs.
SEE ALSO	received_nsf

record_control

DATA TYPE	GFQINT
DESCRIPTION	This is a 16-bit field used for management of the queue record. The bits used by GDK functions are 0, 1, 2, 4, 5, 6, and 7. Bit 0 is "0" (zero) when the record is not busy and "1" when the record is busy. Bit 2 is "0" (zero) when the record is not "off the host" and "1" when the record is "off the host."
	When a record is submitted to the Pending List for transmission, its record_control value is "0" (zero). When it is moved by the Dispatcher into a buffer, it is "1." When the Dispatcher sends it to the on-board software for transmission, it changes to "5." When the record is posted and the transmission is complete, the record_control value is "0" (zero).
	During the course of a fax transmission, the record_control field goes through a series of steps. At each step, the values in this field change. See Table 21.
VALUE	See Table 22.
USAGE	This field is managed by the GDK software and should not be modified by user programs.
SEE ALSO	"Busy Records" section.

Table 21. Transmission Steps and record_control Field Values

Step	Values
A record is submitted to the Pending List.	xxxx x0x0
The Dispatcher moves the record into a buffer.	xxxx x0x1
The Dispatcher sends the record to the fax channel.	xxxx x1x1
The record is posted.	xxxx x0x0

Table 22. Values and Flags of the record_control Field

Bit	Bit Value of 0	Bit Value of 1	Flag Name
b0	Queue record not busy	Queue record busy	GFQRECORD_BUSY
b1	Template	Transaction	GFQTEMPLATE_RECORD
b2	On host	Off host	GFQRECORD_ON_HOST
b3	(Reserved)
b4	No post	Post	GFQPOST_RECORD
b5	Resubmit off	Resubmit on	GFQRESUBMIT_ON
b6	Not viewed/printed	Viewed/printed	GFQRECORD_VIEWED
b7	Not routed	Routed	GFQRECORD_ROUTED
...
b15	(Reserved)

retry_counter

DATA TYPE	GFQINT
DESCRIPTION	This field counts the call-processing submissions, even though it is called a "retry" field. It specifies the total number of calls to be attempted, and not the number of "retries." However, if the value of the field is set to zero, a file gets one transmission attempt by default. Because every record gets at least one transmission attempt, this field counts that first attempt as a "retry." A value does not have to be assigned to retry_counter, unless a number other than the default is desired.
	If the -1 option is selected, retrying continues indefinitely, or for a specified period of time. However, the maximum value of the retry_counter may be restricted by PTT requirements in certain countries. This is only used in the Queue Programming model.
VALUE	-1, positive integers to 32767.
USAGE	qrec->retry_counter = 3;

retry_delay

DATA TYPE	GFQINT
DESCRIPTION	This field specifies the number of minutes that must elapse before another retry is attempted. The default is 30 minutes. This field does not have to be initialized unless this value is to be changed. PTT requirements in some countries may specify a minimum retry_delay time. This is only used in the Queue Programming model.
VALUE	Positive integers to 32767.
USAGE	qrec->retry_delay = 30;

retry_end_time

DATA TYPE	GFQTIME
DESCRIPTION	When a queue record is submitted for polling operations, it must have a start and stop time. This field indicates the stop time in seconds. If the record has not been processed successfully by its stop time, processing is discontinued, and the record is posted to the appropriate completion list. In that event, the retry_counter is set to -1. This is only used in the Queue Programming model. To specify a wait time for answer-operations in the GRT-based programming model, use the "control" field.
VALUE	Positive integers to 32767.
USAGE	qrec->retry_end_time = qrec->time + 3600;
SEE ALSO	retry_counter

retry_strategy

DATA TYPE	GFQINT
DESCRIPTION	If a record fails, the Queue Manager uses the type of retry strategy specified in this field
	The only retry strategy implemented at this time is specified with the parameter GFQFULL_RETRY.
VALUE	GFQFULL_RETRY.
USAGE	qrec->retry_strategy = GFQFULL_RETRY;

security

DATA TYPE	GFQLONG
DESCRIPTION	This field is used for checking the answering Customer Subscriber Identification (CSID) against the telephone number that was dialed. It contains the number of digits to be checked. One or all digits dialed, except for dashes and commas, can be checked against the CSID supplied by the called party to verify that the correct number was reached.
	A match of "n" numbers is performed; if there is no match, your system disconnects. If logging is enabled at the appropriate level, the message "Security check failed" is returned. A value of zero indicates no security.
VALUE	None.
USAGE	qrec->security = 3;

signal_quality

DATA TYPE	GFQINT
DESCRIPTION	This field contains the signal quality, which is measured by the modem during handshaking procedures. This field is useful for determining if a failure in transmission is due to line problems.
VALUE	See Table 23.
USAGE	This field is managed by the GDK software and should not be modified by user programs.

Table 23. Values of the signal_quality Field

Speed	Mode	High	Average	Marginal
14400	V.17	0	768	1024
12000	V.17	0	1792	2560
9600	V.17	0	4608	5632
7200	V.17	0	7168	10240
9600	V.29	0	960	2048
7200	V.29	0	2112	4352
4800	V.27	0	1600	3328
2400	V.27	0	9408	18944

signal_strength

DATA TYPE	GFQINT
DESCRIPTION	This field holds the signal strength, which is measured by the modem during handshaking. It is useful for determining if a failure in transmission is due to line problems.
VALUE	See Table 24.
USAGE	This field is managed by GDK software and should not be modified by user programs.

Table 24. Values of the signal_strength Field

Value	dBm	Strength
6750	-40	Marginal
10000	-35	Weak
13250	-30	Acceptable
16250	-25	Good
19750	-20	Strong
23000	-15	Very strong

source_type

DATA TYPE	GFQINT
DESCRIPTION	When a file to be sent is submitted to the Queue File, the user must specify whether the operation involves a single fax or a list of documents. This field contains a description of the file named in fn_send. It must be filled if a file is to be sent.
VALUE	GFQSINGLE_DOC or GFQLIST_OF_DOCS.
USAGE	qrec->source_type = GFQLIST_OF_DOCS;
SEE ALSO	fn_send

status

DATA TYPE	GFQINT
DESCRIPTION	This field contains a code indicating the success or failure of the transaction. A list of error and status codes is given in the Error and Status Codes Manual. Although the function libraries write the status field, codes can be written to it easily for your application.
VALUE	Positive integers to 32767.
USAGE	result = qrec->status;
SEE ALSO	Error and Status Codes Manual

submission_retries

DATA TYPE	GFQINT
DESCRIPTION	This field is used to manipulate retries, and contains the initial value of the retry_counter field. It records the number of retry attempts to be made when a transmission fails. This field is managed by GDK firmware.
VALUE	Positive integers to 32767.
USAGE	This field is managed by the GDK software and should not be modified by user programs.

submission_time

DATA TYPE	GFQTIME
DESCRIPTION	This field is used to manipulate submission times. It records the time at which a queue record was first submitted to the Queue File. The value in the field is the time in seconds from January 1, 1970. This field is managed by GDK firmware.
VALUE	A date/time stamp comprised of positive integers.
USAGE	This field is managed by GDK software and should not be modified by user programs.

time

DATA TYPE	GFQTIME
DESCRIPTION	When a record is submitted to the Queue File, it must contain the time it is to be processed or was processed, which is specified by this field.
VALUE	None.
USAGE	time (&(qrec->time)); /*for immediate processing*/

transmit_control

DATA TYPE	GFQINT
DESCRIPTION	This field is a 16-bit switch that controls various aspects of the Send operation. If all bits are set to 0, no special features will be included. Setting the first bit allows a cover page to be sent. Setting the second bit allows a header to be sent. Setting the third bit turns on the non-standard-facilities (NSF) field during transmission. This field must be specified when used in conjunction with the various controls.
VALUE	GFQUSE_COVERSHEET, GFQUSE_HEADER, GFQUSE_NSF, GFQUSE_OVERLAY_HEADER, GFQUSE_OVERLAY_HEADER_OR.
USAGE	qrec->transmit_control|= GFQUSE_HEADER; qrec->transmit_control|= GFQUSE_NSF;
SEE ALSO	nsf_field and fn_cover field descriptions.

user_id

DATA TYPE	GFQBYTE[GFQUSER_FIELD_SIZE]
DESCRIPTION	This 32-byte field indicates the submitter of the record, a network address, and a password. It can contain any alphanumeric characters; it also can be empty. Records may be submitted to the Queue File by specifying this field and using a function such as gfqSubmit.
	If the fax channel receives any routing information, it will post the results in as a coded field.
	For example:
	SYSOP;D=XXXX
	where "SYSOP" is the name generated by the communications program ";D" is a separator, and "XXXX" represents the DID (direct inward dialing) or DTMF (dual-tone multi-frequency) digits; or SYSOP;S:=YYYY... where ";S:" is a separator and "YYYY..." represents a received subaddress. Or ;P:=ZZZ... where ";P:" is a separator and "ZZZ..." represents a T.30 password.
VALUE	A character array of size [GFQUSER_FIELD_SIZE].
USAGE	strcpy (qrec->user_id,"John");
SEE ALSO	"Routing" section in Chapter 2.

Click here to contact Dialogic Customer Engineering