2.5.27. TAPOp_PingServer

This provides a heartbeat function.

Syntax

#include “tapop.h”

extern TAPOp_Error TAPOp_PingServer(unsigned8 connectId);

where:

connectId

Connection ID, as returned by TAPOp_OpenConnection.

Return

The function returns:

TAPOp_NoError

No error.

TAPOp_NoSuchConnection

The connectId was not recognized.

TAPOp_RPC_Connection_Fail

The RPC connection was lost while processing thisrequest.

Usage

The function is used to poll the server so that the server knows the client is still connected during periods of inactivity. Although this function is part of the TAPOp public interface, it is not used in the user-written parts of Windows clients, because the code provided in rpcclient.c sets up a thread that calls this function once per second when a connection is active.

UNIX clients must call TAPOp_PingServer periodically if the autodisconnect behavior described in TAPOp_OpenConnection is required.

See also

This TAPOp API function provides similar or related functionality:

Copyright © 1998-2002 ARM Limited. All rights reserved.ARM DUI 0154B
Non-Confidential