A-30
A2
C.12 keepalive
The keepalive procedure is used to read/modify the keepalive value. If set
to zero, then keepalives will not be used. If used, then this is the time (in
seconds) of inactivity prior to a keepalive being sent.
struct Keepalive_Parms {
unsigned
int
action;
unsigned
int
time;
};
struct Keepalive_Resp {
unsigned
int
error;
unsigned
int
time;
};
Keepalive_Resp keepalive (Keepalive_Parms) = 12;
The action value determines whether the client wishes to execute a read of
the current setting, or a modifi cation of the current value.
action = 0 = read of current value
action = 1 = modify current value
If the action value is other than 0 or 1, then an error value of 5 is re-
turned.
If the RPC message is of insuffi cient length to satisfy the required length,
an error value of 1 is returned.
The time value is not range checked, thus it is possible to defi ne an impos-
sible timeout period. A time value of zero prevents keepalive from being
used. If a channel remains inactive for the specifi ed time period, then a
keepalive is sent (assuming time is non-zero). The returned Keepalive_Resp
structure will always contain the current keepalive value, irrespective of
the error value.
* Note that the Keepalive time may be fi xed and not variable. If non-zero
time is specifi ed, Keepalive will be active regardless of time.
error Meaning
0
No error
1
Syntax error
5
Parameter error
Summary of Contents for N4865A
Page 20: ...1 16 1 This page left intentionally blank ...
Page 32: ...2 12 2 This page left intentionally blank ...
Page 40: ...3 8 3 This page left intentionally blank ...
Page 44: ...4 4 4 This page purposely left blank ...
Page 96: ...A 44 A2 This page purposely left blank ...
Page 100: ...Index 4 I This page left intentionally blank ...