aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking/rxrpc.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/networking/rxrpc.txt')
-rw-r--r--Documentation/networking/rxrpc.txt17
1 files changed, 11 insertions, 6 deletions
diff --git a/Documentation/networking/rxrpc.txt b/Documentation/networking/rxrpc.txt
index 605e00cdd6be..89f1302d593a 100644
--- a/Documentation/networking/rxrpc.txt
+++ b/Documentation/networking/rxrpc.txt
@@ -1056,18 +1056,23 @@ The kernel interface functions are as follows:
1056 1056
1057 u32 rxrpc_kernel_check_life(struct socket *sock, 1057 u32 rxrpc_kernel_check_life(struct socket *sock,
1058 struct rxrpc_call *call); 1058 struct rxrpc_call *call);
1059 void rxrpc_kernel_probe_life(struct socket *sock,
1060 struct rxrpc_call *call);
1059 1061
1060 This returns a number that is updated when ACKs are received from the peer 1062 The first function returns a number that is updated when ACKs are received
1061 (notably including PING RESPONSE ACKs which we can elicit by sending PING 1063 from the peer (notably including PING RESPONSE ACKs which we can elicit by
1062 ACKs to see if the call still exists on the server). The caller should 1064 sending PING ACKs to see if the call still exists on the server). The
1063 compare the numbers of two calls to see if the call is still alive after 1065 caller should compare the numbers of two calls to see if the call is still
1064 waiting for a suitable interval. 1066 alive after waiting for a suitable interval.
1065 1067
1066 This allows the caller to work out if the server is still contactable and 1068 This allows the caller to work out if the server is still contactable and
1067 if the call is still alive on the server whilst waiting for the server to 1069 if the call is still alive on the server whilst waiting for the server to
1068 process a client operation. 1070 process a client operation.
1069 1071
1070 This function may transmit a PING ACK. 1072 The second function causes a ping ACK to be transmitted to try to provoke
1073 the peer into responding, which would then cause the value returned by the
1074 first function to change. Note that this must be called in TASK_RUNNING
1075 state.
1071 1076
1072 (*) Get reply timestamp. 1077 (*) Get reply timestamp.
1073 1078