SolarCapture C Bindings
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
session.h
Go to the documentation of this file.
1 
8 #ifndef __SOLAR_CAPTURE_SESSION_H__
9 #define __SOLAR_CAPTURE_SESSION_H__
10 
11 
12 struct sc_session;
13 
18  char* err_msg; /*< The error message. */
19  char* err_func; /*< The function the error occurred in. */
20  char* err_file; /*< The source file the error occurred in. */
21  int err_line; /*< The line number the error was issued from. */
22  int err_errno; /*< The errno for the error. */
23 };
24 
25 
37 extern int sc_session_alloc(struct sc_session** scs_out,
38  const struct sc_attr* attr);
39 
40 
41 #if SC_API_VER >= 3
42 
57 extern int sc_session_prepare(struct sc_session* scs);
58 #endif
59 
60 
70 extern int sc_session_go(struct sc_session* scs);
71 
72 
73 #if SC_API_VER >= 3
74 
81 extern int sc_session_pause(struct sc_session* scs);
82 #endif
83 
84 
85 #if SC_API_VER >= 3
86 
97 extern struct sc_session_error* sc_session_error_get(struct sc_session* scs);
98 #endif
99 
100 
101 #if SC_API_VER >= 3
102 
110 extern void sc_session_error_free(struct sc_session* scs, struct sc_session_error* err);
111 #endif
112 
113 #endif /* __SOLAR_CAPTURE_SESSION_H__ */
114 
Attribute object.
int sc_session_pause(struct sc_session *scs)
Pause a SolarCapture session.
int sc_session_go(struct sc_session *scs)
Start a SolarCapture session.
int sc_session_alloc(struct sc_session **scs_out, const struct sc_attr *attr)
Allocate a SolarCapture session.
A SolarCapture session error object returned by sc_session_error_get.
Definition: session.h:17
void sc_session_error_free(struct sc_session *scs, struct sc_session_error *err)
Frees an error object.
struct sc_session_error * sc_session_error_get(struct sc_session *scs)
Returns an error from a SolarCapture session.
int sc_session_prepare(struct sc_session *scs)
Prepare a SolarCapture session.