gclib 2.4.0
Galil Communications Library
Loading...
Searching...
No Matches
gclibo.h File Reference
#include "gclib.h"

Go to the source code of this file.

Macros

#define MALLOCBUF   G_HUGE_BUFFER
 Malloc used for large program and array uploads.
#define MAXPROG   MALLOCBUF
 Maximum size for a program.
#define MAXARRAY   MALLOCBUF
 Maximum size for an array table upload.
#define POLLINGINTERVAL   100
 Interval, in milliseconds, for polling commands, e.g. GWaitForBool().
#define G_USE_GCAPS
 Use the GCAPS server in GAddresses(), GAssign(), GIpRequests(), and GVersion(). To avoid GCAPS, comment out this line and recompile, http://galil.com/sw/pub/all/doc/gclib/html/gclibo.html.

Functions

GCLIB_DEPRECATED void GSleep (unsigned int timeout_ms)
GCLIB_DEPRECATED GReturn GVersion (GCStringOut ver, GSize ver_len)
 Uses GUtility(), G_UTIL_VERSION and G_UTIL_GCAPS_VERSION to provide the library and gcaps version numbers.
GCLIB_DEPRECATED GReturn GAddresses (GCStringOut addresses, GSize addresses_len)
 Uses GUtility(), G_UTIL_GCAPS_ADDRESSES or G_UTIL_ADDRESSES to provide a listing of all available connection addresses.
GCLIB_DEPRECATED GReturn GInfo (GCon g, GCStringOut info, GSize info_len)
 Uses GUtility() and G_UTIL_INFO to provide a useful connection string.
GCLIB_DEPRECATED GReturn GTimeout (GCon g, short timeout_ms)
 Uses GUtility() and G_UTIL_TIMEOUT_OVERRIDE to set the library timeout.
GCLIB_DEPRECATED GReturn GCmd (GCon g, GCStringIn command)
 Wrapper around GCommand for use when the return value is not desired.
GCLIB_DEPRECATED GReturn GCmdT (GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut *front)
 Wrapper around GCommand that trims the response.
GCLIB_DEPRECATED GReturn GCmdI (GCon g, GCStringIn command, int *value)
 Wrapper around GCommand that provides the return value of a command parsed into an int.
GCLIB_DEPRECATED GReturn GCmdD (GCon g, GCStringIn command, double *value)
 Wrapper around GCommand that provides the return value of a command parsed into a double.
GCLIB_DEPRECATED GReturn GWaitForBool (GCon g, GCStringIn predicate, int trials)
 Blocking call that returns when the controller evaluates the predicate as true.
GCLIB_DEPRECATED GReturn GMotionComplete (GCon g, GCStringIn axes)
 Blocking call that returns once all axes specified have completed their motion.
GCLIB_DEPRECATED GReturn GRecordRate (GCon g, double period_ms)
 Sets the asynchronous data record to a user-specified period via DR.
GCLIB_DEPRECATED GReturn GProgramDownloadFile (GCon g, GCStringIn file_path, GCStringIn preprocessor)
 Program download from file.
GCLIB_DEPRECATED GReturn GProgramUploadFile (GCon g, GCStringIn file_path)
 Program upload to file.
GCLIB_DEPRECATED GReturn GArrayDownloadFile (GCon g, GCStringIn file_path)
 Array download from file.
GCLIB_DEPRECATED GReturn GArrayUploadFile (GCon g, GCStringIn file_path, GCStringIn names)
 Array upload to file.
GCLIB_DEPRECATED GReturn GIpRequests (GCStringOut requests, GSize requests_len)
 Uses GUtility(), G_UTIL_GCAPS_IPREQUEST or G_UTIL_IPREQUEST to provide a list of all Galil controllers requesting IP addresses via BOOT-P or DHCP.
GCLIB_DEPRECATED GReturn GSetServer (GCStringIn server_name)
 Uses GUtility(), G_UTIL_GCAPS_SET_SERVER to set the new active server.
GCLIB_DEPRECATED GReturn GListServers (GCStringOut servers, GSize servers_len)
 Uses GUtility(), G_UTIL_GCAPS_LIST_SERVERS to provide a list of all available gcaps services on the local network.
GCLIB_DEPRECATED GReturn GPublishServer (GCStringIn name, GOption publish, GOption save)
 Uses GUtility(), G_UTIL_GCAPS_PUBLISH_SERVER to publish local gcaps server to the local network.
GCLIB_DEPRECATED GReturn GServerStatus (GCStringOut status, GSize status_len)
 Uses GUtility(), G_UTIL_GCAPS_SERVER_STATUS to get information on the local server name and if it is published to the local network.
GCLIB_DEPRECATED GReturn GRemoteConnections (GCStringOut connections, GSize connections_length)
 Uses GUtility(), G_UTIL_GCAPS_REMOTE_CONNECTIONS to get a list of remote addresses connected to the local server.
GCLIB_DEPRECATED GReturn GAssign (GCStringIn ip, GCStringIn mac)
 Uses GUtility(), G_UTIL_GCAPS_ASSIGN or G_UTIL_ASSIGN to assign an IP address over the Ethernet to a controller at a given MAC address.
GCLIB_DEPRECATED void GError (GReturn rc, GCStringOut error, GSize error_len)
 Provides a human-readable description string for return codes.
GCLIB_DEPRECATED GReturn GSetupDownloadFile (GCon g, GCStringIn file_path, GOption options, GCStringOut info, GSize info_len)
 Download a saved controller configuration from a file.

Macro Definition Documentation

◆ MALLOCBUF

#define MALLOCBUF   G_HUGE_BUFFER

Malloc used for large program and array uploads.

Definition at line 13 of file gclibo.h.

◆ MAXPROG

#define MAXPROG   MALLOCBUF

Maximum size for a program.

Definition at line 14 of file gclibo.h.

◆ MAXARRAY

#define MAXARRAY   MALLOCBUF

Maximum size for an array table upload.

Definition at line 15 of file gclibo.h.

◆ POLLINGINTERVAL

#define POLLINGINTERVAL   100

Interval, in milliseconds, for polling commands, e.g. GWaitForBool().

Definition at line 16 of file gclibo.h.

◆ G_USE_GCAPS

#define G_USE_GCAPS

Use the GCAPS server in GAddresses(), GAssign(), GIpRequests(), and GVersion(). To avoid GCAPS, comment out this line and recompile, http://galil.com/sw/pub/all/doc/gclib/html/gclibo.html.

Definition at line 17 of file gclibo.h.