Skip to content

Commit 6426065

Browse files
committed
feat: add documentation on samples and bump to first minor release
1 parent 259fef1 commit 6426065

File tree

4 files changed

+21
-7
lines changed

4 files changed

+21
-7
lines changed

examples/client_continuous.c

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* Sample to test HTTPS-notif library performance
3+
*/
4+
15
#include <stdio.h>
26
#include <stdlib.h>
37
#include <string.h>
@@ -6,9 +10,12 @@
610
#include "../src/unyte_https_utils.h"
711

812
#define MAX_TO_RECEIVE 200
9-
#define SERVERKEYFILE "private.key"
10-
#define SERVERCERTFILE "certificate.pem"
13+
#define SERVERKEYFILE "private.key" // Should be generated before run this sample
14+
#define SERVERCERTFILE "certificate.pem" // Should be generated before run this sample
1115

16+
/**
17+
* Read file and return bytes
18+
*/
1219
char *load_file(const char *file_path)
1320
{
1421
FILE *infile;

examples/client_sample.c

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* Sample to show how to consume HTTPS-notif protocol using the library
3+
*/
4+
15
#include <stdio.h>
26
#include <stdlib.h>
37
#include <string.h>
@@ -6,9 +10,12 @@
610
#include "../src/unyte_https_utils.h"
711

812
#define MAX_TO_RECEIVE 10
9-
#define SERVERKEYFILE "private.key"
10-
#define SERVERCERTFILE "certificate.pem"
13+
#define SERVERKEYFILE "private.key" // Should be generated before run this sample
14+
#define SERVERCERTFILE "certificate.pem" // Should be generated before run this sample
1115

16+
/**
17+
* Read file and return bytes
18+
*/
1219
char *load_file(const char *file_path)
1320
{
1421
FILE *infile;

src/unyte_https_version.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#define UNYTE_HTTPS_VERSION_H
33

44
#define UNYTE_HTTPS_NOTIF_VERSION_MAJOR 0
5-
#define UNYTE_HTTPS_NOTIF_VERSION_MINOR 0
6-
#define UNYTE_HTTPS_NOTIF_VERSION_PATCH 1
5+
#define UNYTE_HTTPS_NOTIF_VERSION_MINOR 1
6+
#define UNYTE_HTTPS_NOTIF_VERSION_PATCH 0
77

88
#endif

unyte-pkg.pc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ libdir=${exec_prefix}/<<lib>>
55

66
Name: unyte-https-notif
77
Description: Unyte HTTPS-notif protocol library
8-
Version: 0.0.1
8+
Version: 0.1.0
99
Cflags: -I${includedir}/unyte-https-notif
1010
Libs: -L${libdir} -lunyte-https-notif

0 commit comments

Comments
 (0)