Skip to content
Start free evaluation

pdcomm_gem_equipment_operator_offline

Function

Takes the equipment to EQUIPMENT OFF-LINE (the operator's OFF-LINE switch).

PdcommStatus pdcomm_gem_equipment_operator_offline(PdcommTcpEndpoint *endpoint)

Declared in: #include <pdcomm_gem.h>

Allowed in #PDCOMM_GEM_ONLINE_LOCAL, #PDCOMM_GEM_ONLINE_REMOTE, and #PDCOMM_GEM_HOST_OFFLINE, as in the SEMI E30 control state model. It is a local operator action: no message is sent and no connection is required. #PDCOMM_GEM_ATTEMPT_ONLINE ends only with its S1F1 transaction.

Parameters

NameDescription
endpointLive TCP endpoint with an equipment role.

Returns

#PDCOMM_OK when the control state is #PDCOMM_GEM_EQUIPMENT_OFFLINE; #PDCOMM_INVALID_ARGUMENT when endpoint is NULL; #PDCOMM_INVALID_STATE when the endpoint has no equipment role or the control state is #PDCOMM_GEM_EQUIPMENT_OFFLINE or #PDCOMM_GEM_ATTEMPT_ONLINE; #PDCOMM_BACKPRESSURE when a staged TCP event exists; #PDCOMM_POISONED when the endpoint is poisoned.

Privacy Policy