pdcomm_gem_equipment_set_online_mode
Function
Sets the operator's REMOTE/LOCAL switch.
PdcommStatus pdcomm_gem_equipment_set_online_mode(PdcommTcpEndpoint *endpoint, uint32_t mode)Allowed in every control state; a connection is not required and no message is sent. As in the SEMI E30 control state model, an ON-LINE equipment moves to #PDCOMM_GEM_ONLINE_LOCAL or #PDCOMM_GEM_ONLINE_REMOTE at once; in the OFF-LINE states the mode selects the substate entered at the next ON-LINE transition.
Parameters
| Name | Description |
|---|---|
endpoint | Live TCP endpoint with an equipment role. |
mode | #PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE. |
Returns
#PDCOMM_OK on success; #PDCOMM_INVALID_ARGUMENT when endpoint is NULL or mode is invalid; #PDCOMM_INVALID_STATE when the endpoint has no equipment role; #PDCOMM_BACKPRESSURE when a staged TCP event exists; #PDCOMM_POISONED when the endpoint is poisoned.