com.cafesoft.cams.ping
Interface PingService

All Superinterfaces:

Debuggable, Service

public interface PingService

extends Service

Defines an interface for a client-side PingService hosted under a CamsClient.

Since:

11/15/02

Method Summary

PingRequest	createPingRequest() Create an empty PingRequest.
void	destroy(PingRequest pingReq) Destroy an PingRequest.
void	destroy(PingResponse pingRes) Destroy an PingResponse.
PingResponse	ping(PingRequest pingReq) Ping the Cams server

Methods inherited from interface com.cafesoft.core.service.Service

destroy, getServiceConfig, initialize

Methods inherited from interface com.cafesoft.core.util.Debuggable

setDebug

Method Detail

ping

public PingResponse ping(PingRequest pingReq)
                  throws PingException

Ping the Cams server

Parameters:

pingReq - the access control request

Returns:

pingRes the access control response

Throws:

PingException - if an error when executing the ping

See Also:

PingRequest, PingResponse, PingException

createPingRequest

public PingRequest createPingRequest()

Create an empty PingRequest.

Returns:

an empty PingRequest.

destroy

public void destroy(PingRequest pingReq)

Destroy an PingRequest.

Parameters:

pingReq - the PingRequest to be destroyed.

destroy

public void destroy(PingResponse pingRes)

Destroy an PingResponse.

Parameters:

pingRes - the PingResponse to be destroyed.