| gclib 2.4.1 Galil Communications Library

Loading...
Searching...
No Matches
gclibo.h
Go to the documentation of this file.
1#pragma once
2
3#include "gclib.h"
4
5#ifndef _WIN32
6#pragma GCC visibility push(default)
7#endif
8
9#ifdef __cplusplus
10 extern "C" {
11#endif
12
13#define MALLOCBUF G_HUGE_BUFFER
14#define MAXPROG MALLOCBUF
15#define MAXARRAY MALLOCBUF
16#define POLLINGINTERVAL 100
17#define G_USE_GCAPS
18
19 GCLIB_DEPRECATED void GSleep(unsigned int timeout_ms);
27
29 GCLIB_DEPRECATED GReturn GVersion(GCStringOut ver, GSize ver_len);
52
54 GCLIB_DEPRECATED GReturn GAddresses(GCStringOut addresses, GSize addresses_len);
85
87 GCLIB_DEPRECATED GReturn GInfo(GCon g, GCStringOut info, GSize info_len);
102
103
105 GCLIB_DEPRECATED GReturn GTimeout(GCon g, short timeout_ms);
115
116
118 GCLIB_DEPRECATED GReturn GCmd(GCon g, GCStringIn command);
131
132
134 GCLIB_DEPRECATED GReturn GCmdT(GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut* front);
151
152
154 GCLIB_DEPRECATED GReturn GCmdI(GCon g, GCStringIn command, int* value);
168
169
171 GCLIB_DEPRECATED GReturn GCmdD(GCon g, GCStringIn command, double* value);
186
188 GCLIB_DEPRECATED GReturn GWaitForBool(GCon g, GCStringIn predicate, int trials);
211
213 GCLIB_DEPRECATED GReturn GMotionComplete(GCon g, GCStringIn axes);
229
231 GCLIB_DEPRECATED GReturn GRecordRate(GCon g, double period_ms);
244
245
247 GCLIB_DEPRECATED GReturn GProgramDownloadFile(GCon g, GCStringIn file_path, GCStringIn preprocessor);
258
259
261 GCLIB_DEPRECATED GReturn GProgramUploadFile(GCon g, GCStringIn file_path);
271
272
274 GCLIB_DEPRECATED GReturn GArrayDownloadFile(GCon g, GCStringIn file_path);
287
288
290 GCLIB_DEPRECATED GReturn GArrayUploadFile(GCon g, GCStringIn file_path, GCStringIn names);
304
305
307 GCLIB_DEPRECATED GReturn GIpRequests(GCStringOut requests, GSize requests_len);
334
336 GCLIB_DEPRECATED GReturn GSetServer(GCStringIn server_name);
354
356 GCLIB_DEPRECATED GReturn GListServers(GCStringOut servers, GSize servers_len);
375
377 GCLIB_DEPRECATED GReturn GPublishServer(GCStringIn name, GOption publish, GOption save);
403
405 GCLIB_DEPRECATED GReturn GServerStatus(GCStringOut status, GSize status_len);
427
428
430 GCLIB_DEPRECATED GReturn GRemoteConnections(GCStringOut connections, GSize connections_length);
452
454 GCLIB_DEPRECATED GReturn GAssign(GCStringIn ip, GCStringIn mac);
478
480 GCLIB_DEPRECATED void GError(GReturn rc, GCStringOut error, GSize error_len);
489
491 GCLIB_DEPRECATED GReturn GSetupDownloadFile(GCon g, GCStringIn file_path, GOption options, GCStringOut info, GSize info_len);
549
550#ifdef __cplusplus
551} //extern "C"
552#endif
553
554#ifndef _WIN32
555#pragma GCC visibility pop
556#endif
gclib.h
GReturn
int GReturn
Every function returns a value of type GReturn. See gclib_errors.h for possible values.
Definition gclib_compat.h:94
GOption
int GOption
Option integer for various formatting, etc.
Definition gclib_compat.h:97
GCLIB_DEPRECATED
#define GCLIB_DEPRECATED
Definition gclib_compat.h:35
GSize
unsigned int GSize
Size of buffers, etc.
Definition gclib_compat.h:96
GCon
struct Context * GCon
Connection handle. Unique for each connection in process. Assigned a non-zero value in GOpen().
Definition gclib_compat.h:95
GCStringOut
char * GCStringOut
C-string output from the library. Implies null-termination.
Definition gclib_compat.h:98
GCStringIn
const char * GCStringIn
C-string input to the library. Implies null-termination.
Definition gclib_compat.h:99
GSleep
GCLIB_DEPRECATED void GSleep(unsigned int timeout_ms)
GError
GCLIB_DEPRECATED void GError(GReturn rc, GCStringOut error, GSize error_len)
Provides a human-readable description string for return codes.
GVersion
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 num...
GCmdI
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.
GCmdT
GCLIB_DEPRECATED GReturn GCmdT(GCon g, GCStringIn command, GCStringOut trimmed_response, GSize response_len, GCStringOut *front)
Wrapper around GCommand that trims the response.
GCmdD
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.
GCmd
GCLIB_DEPRECATED GReturn GCmd(GCon g, GCStringIn command)
Wrapper around GCommand for use when the return value is not desired.
GIpRequests
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 controller...
GAddresses
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 con...
GInfo
GCLIB_DEPRECATED GReturn GInfo(GCon g, GCStringOut info, GSize info_len)
Uses GUtility() and G_UTIL_INFO to provide a useful connection string.
GAssign
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 ...
GTimeout
GCLIB_DEPRECATED GReturn GTimeout(GCon g, short timeout_ms)
Uses GUtility() and G_UTIL_TIMEOUT_OVERRIDE to set the library timeout.
GWaitForBool
GCLIB_DEPRECATED GReturn GWaitForBool(GCon g, GCStringIn predicate, int trials)
Blocking call that returns when the controller evaluates the predicate as true.
GMotionComplete
GCLIB_DEPRECATED GReturn GMotionComplete(GCon g, GCStringIn axes)
Blocking call that returns once all axes specified have completed their motion.
GSetupDownloadFile
GCLIB_DEPRECATED GReturn GSetupDownloadFile(GCon g, GCStringIn file_path, GOption options, GCStringOut info, GSize info_len)
Download a saved controller configuration from a file.
GProgramUploadFile
GCLIB_DEPRECATED GReturn GProgramUploadFile(GCon g, GCStringIn file_path)
Program upload to file.
GProgramDownloadFile
GCLIB_DEPRECATED GReturn GProgramDownloadFile(GCon g, GCStringIn file_path, GCStringIn preprocessor)
Program download from file.
GArrayDownloadFile
GCLIB_DEPRECATED GReturn GArrayDownloadFile(GCon g, GCStringIn file_path)
Array download from file.
GArrayUploadFile
GCLIB_DEPRECATED GReturn GArrayUploadFile(GCon g, GCStringIn file_path, GCStringIn names)
Array upload to file.
GRemoteConnections
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 l...
GSetServer
GCLIB_DEPRECATED GReturn GSetServer(GCStringIn server_name)
Uses GUtility(), G_UTIL_GCAPS_SET_SERVER to set the new active server.
GPublishServer
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.
GServerStatus
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 ...
GListServers
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 l...
GRecordRate
GCLIB_DEPRECATED GReturn GRecordRate(GCon g, double period_ms)
Sets the asynchronous data record to a user-specified period via DR.