Truxton etl get description - Revision history

Sam at 19:17, 19 March 2021

2021-03-19T19:17:31Z

Sam at 19:12, 19 March 2021

2021-03-19T19:12:06Z

Sam: /* Sample */

2021-02-10T15:25:54Z

Sample

Sam at 15:18, 10 February 2021

2021-02-10T15:18:38Z

Sam at 19:06, 4 December 2020

2020-12-04T19:06:50Z

Sam at 10:46, 10 June 2020

2020-06-10T10:46:17Z

Sam: /* Sample */

2020-05-26T10:40:04Z

Sample

Sam: Created page with "This is used to build the command line arguments for the process. Truxton will automatically parse the command line for you but this allows you to programmatically force comma..."

2020-05-26T09:48:29Z

Created page with "This is used to build the command line arguments for the process. Truxton will automatically parse the command line for you but this allows you to programmatically force comma..."

New page

This is used to build the command line arguments for the process.
Truxton will automatically parse the command line for you but this allows you to programmatically force command line options.

=Syntax=
<syntaxhighlight lang="C">
void truxton_etl_get_description(uint64_t etl_handle, char * destination_string, size_t maximum_size)
</syntaxhighlight>

=Parameters=
==<code>etl_handle</code>==

The handle created by the [[truxton_etl_create]] call.

==<code>destination_string</code>==
The string buffer where the description will go.

==<code>maximum_size</code>==
The size of the <code>destination_string</code> buffer.
The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.]

=Sample=

<syntaxhighlight lang="C" highlight="18">
#include <TruxtonCAPI.h>

void main( void )
{
char file_id[ 65 ];
char description[ 128 ];

int exit_loop = 0;

uint64_t message = 0;
uint64_t app = truxton_etl_create();

truxton_etl_set_application_name( app, "Sample C ETL" );
truxton_etl_set_stage_number( app, 42 );
truxton_etl_set_queue_name( app, "SampleC" );

truxton_etl_set_description( app, "A sample of how to write an ETL");
truxton_etl_add_get_description( app, description, sizeof(description));

while( exit_loop == 0 )
{
message = truxton_etl_get_message( app );

if ( message != 0 )
{
// Do something with the message

memset( file_id, 0x00, sizeof( file_id ) );
truxton_message_get_file_id( message, file_id, sizeof( file_id ) );

printf( "Received file id %s\n", file_id );

truxton_message_destroy( message );
}
else
{
exit_loop = 1;
}
}
}
</syntaxhighlight>

@@ Line 55: / Line 55: @@
          message = truxton_etl_get_message( app );
+     }
+}
 </source>

@@ Line 4: / Line 4: @@
 =Syntax=
 <source lang="C">
-void truxton_etl_get_description(uint64_t etl_handle, char * destination_string, size_t maximum_size);
+void truxton_etl_get_description( uint64_t etl_handle, char * destination_string, size_t maximum_size );
 </source>
@@ Line 35: / Line 35: @@
      truxton_etl_set_queue_name( app, "SampleC" );
-     truxton_etl_set_description( app, "A sample of how to write an ETL");
+     truxton_etl_set_description( app, "A sample of how to write an ETL" );
-     truxton_etl_get_description( app, description, sizeof(description));
+     truxton_etl_get_description( app, description, sizeof(description) );
      // Pause here until we get a message from the "SampleC" message queue

@@ Line 16: / Line 16: @@
 The size of the <code>destination_string</code> buffer.
 The maximum number of characters written to the buffer will be <code>maximum_size</code> minus one to leave room for the [https://en.wikipedia.org/wiki/Null-terminated_string null terminator.]
 =Sample=

@@ Line 1: / Line 1: @@
-This is used to build the command line arguments for the process.
+This retrieves the description of the ETL application.
 =Syntax=
@@ Line 9: / Line 8: @@
 =Parameters=
 ==<code>etl_handle</code>==
 The handle created by the [[truxton_etl_create]] call.
@@ Line 55: / Line 53: @@
          message = truxton_etl_get_message( app );
+     }
      truxton_etl_destroy( app );
+}
 </source>

@@ Line 3: / Line 3: @@
 =Syntax=
-<syntaxhighlight lang="C">
+<source lang="C">
 void truxton_etl_get_description(uint64_t etl_handle, char * destination_string, size_t maximum_size);
-</syntaxhighlight>
+</source>
 =Parameters=
@@ Line 20: / Line 20: @@
 =Sample=
-<syntaxhighlight lang="C" highlight="18">
+<source lang="C" highlight="16">
 #include <TruxtonCAPI.h>
@@ Line 27: / Line 27: @@
      char file_id[ 65 ];
      char description[ 128 ];
      uint64_t message = 0;
@@ Line 40: / Line 38: @@
      truxton_etl_get_description( app, description, sizeof(description));
-     while( exit_loop == 0 )
+    // Pause here until we get a message from the "SampleC" message queue
+     {
-         message = truxton_etl_get_message( app );
+         // Do something with the message
-         if ( message != 0 )
+         memset( file_id, 0x00, sizeof( file_id ) );
+         truxton_message_get_file_id( message, file_id, sizeof( file_id ) );
-            memset( file_id, 0x00, sizeof( file_id ) );
+        printf( "Received file id %s\n", file_id );
-            printf( "Received file id %s\n", file_id );
+        truxton_message_destroy( message );
-            truxton_message_destroy( message );
+        // Pause here until we get another message from the "SampleC" message queue
+         message = truxton_etl_get_message( app );
+     }
+}
-</syntaxhighlight>
+</source>