Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds description for all methods within server and client c files wit… #2

Merged
merged 2 commits into from
Jun 4, 2024
Merged

Adds description for all methods within server and client c files wit… #2

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9456103
Adds description for all methods within server and client c files wit…
NihadF7 May 9, 2024
71e37fe
Ticket #36: Resolves PR findings.
NihadF7 May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 175 additions & 14 deletions examples/client/lwm2mclient.c
View file
Open in desktop
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ lwm2m_object_t * objArray[OBJ_COUNT];
# define BACKUP_OBJECT_COUNT 2
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
lwm2m_object_t * backupObjectArray[BACKUP_OBJECT_COUNT];

// Structure to hold client data
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
typedef struct
{
lwm2m_object_t * securityObjP;
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -109,6 +110,13 @@ typedef struct
int addressFamily;
} client_data_t;

/**
* @brief Callback function to quit the LwM2M client.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data User data.
*/
static void prv_quit(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand All @@ -118,14 +126,30 @@ static void prv_quit(lwm2m_context_t * lwm2mH,
(void)buffer;
(void)user_data;

// Set the quit flag to terminate the program
g_quit = 1;
}

/**
* @brief Signal handler for SIGINT (Ctrl+C) for graceful shutdown.
*
* @param lwm2mH LwM2M context.
* @param uri URI of the resource.
*/
void handle_sigint(int signum)
{
// Set the quit flag to initiate a graceful shutdown
g_quit = 2;
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
}

/**
* @brief Callback function for handling value changes in resources.
*
* @param lwm2mH LwM2M context.
* @param uri URI of the resource.
* @param value New value of the resource.
* @param valueLength Length of the new value.
*/
void handle_value_changed(lwm2m_context_t * lwm2mH,
lwm2m_uri_t * uri,
const char * value,
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -206,6 +230,13 @@ void handle_value_changed(lwm2m_context_t * lwm2mH,
}

#ifdef WITH_TINYDTLS
/**
* @brief Connects to the LwM2M server using DTLS.
*
* @param secObjInstID Security Object Instance ID.
* @param userData User data.
* @return void* Pointer to the connection object.
*/
void * lwm2m_connect_server(uint16_t secObjInstID,
void * userData)
{
Expand All @@ -230,6 +261,13 @@ void * lwm2m_connect_server(uint16_t secObjInstID,
return (void *)newConnP;
}
#else
/**
* @brief Connects to the LwM2M server using CoAP.
*
* @param secObjInstID Security Object Instance ID.
* @param userData User data.
* @return void* Pointer to the connection object.
*/
void * lwm2m_connect_server(uint16_t secObjInstID,
void * userData)
{
Expand Down Expand Up @@ -286,6 +324,12 @@ void * lwm2m_connect_server(uint16_t secObjInstID,
}
#endif

/**
* @brief Closes the connection.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs more details. Explaining what happens e.g. WITH_TINYDTLS is defined /not defined?What does lwm2m_free do? etc.

*
* @param sessionH Session handler.
* @param userData User data.
*/
void lwm2m_close_connection(void * sessionH,
void * userData)
{
Expand Down Expand Up @@ -329,6 +373,13 @@ void lwm2m_close_connection(void * sessionH,
}
}

/**
* @brief Outputs information about bootstrap servers and LWM2M servers.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_output_servers(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -416,6 +467,13 @@ static void prv_output_servers(lwm2m_context_t * lwm2mH,
}
}

/**
* @brief Handles resource value changes or value change reports.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Value change of what? received,sent message, health status ? It is inconclusive since we are using full context of the lwm2m. What does handle_value_change do?

*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_change(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -450,6 +508,13 @@ static void prv_change(lwm2m_context_t * lwm2mH,
fprintf(stdout, "Syntax error !\n");
}

/**
* @brief Outputs a list of registered LWM2M objects and their instances.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_object_list(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -478,6 +543,13 @@ static void prv_object_list(lwm2m_context_t * lwm2mH,
}
}

/**
* @brief Dumps the TLV data for a given instance of an object.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is TLV data? This should be described, both with a comment on what does dump_tlv do.

*
* @param lwm2mH Pointer to the LWM2M context.
* @param objectP Pointer to the LWM2M object structure.
* @param id Instance ID of the object.
*/
static void prv_instance_dump(lwm2m_context_t * lwm2mH,
lwm2m_object_t * objectP,
uint16_t id)
Expand All @@ -500,6 +572,13 @@ static void prv_instance_dump(lwm2m_context_t * lwm2mH,
}


/**
* @brief Dumps the TLV data for an object or its instances.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as previous regarding TLV meaning

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do the conditionals mean and what is the procedure behind them?

*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_object_dump(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -548,6 +627,13 @@ static void prv_object_dump(lwm2m_context_t * lwm2mH,
fprintf(stdout, "Syntax error !\n");
}

/**
* @brief Updates the registration with a specified server.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration of what? client with the server, or? When is this executed?

*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer containing the server ID.
* @param user_data Unused parameter.
*/
static void prv_update(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand All @@ -572,6 +658,13 @@ static void prv_update(lwm2m_context_t * lwm2mH,
}

#ifndef LWM2M_VERSION_1_0
/**
* @brief Sends data to specified LWM2M server(s).
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer containing server ID(s) and URI(s).
* @param user_data Unused parameter.
*/
static void prv_send(lwm2m_context_t *lwm2mH, char *buffer, void *user_data) {
lwm2m_uri_t uri;
lwm2m_uri_t *uris = NULL;
Expand Down Expand Up @@ -637,6 +730,11 @@ static void prv_send(lwm2m_context_t *lwm2mH, char *buffer, void *user_data) {
}
#endif

/**
* @brief Updates the simulated battery level and reports it to the LWM2M server.
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
*
* @param context Pointer to the LWM2M context.
*/
static void update_battery_level(lwm2m_context_t * context)
{
static time_t next_change_time = 0;
Expand Down Expand Up @@ -665,6 +763,13 @@ static void update_battery_level(lwm2m_context_t * context)
}
}

/**
* @brief Adds a test object to the LWM2M server.
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_add(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -695,6 +800,13 @@ static void prv_add(lwm2m_context_t * lwm2mH,
return;
}

/**
* @brief Removes the specified object from the LWM2M server.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_remove(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand All @@ -719,7 +831,13 @@ static void prv_remove(lwm2m_context_t * lwm2mH,
}

#ifdef LWM2M_BOOTSTRAP

/**
* @brief Initiates the bootstrap process by resetting the state and lifetime of bootstrap servers.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_initiate_bootstrap(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand All @@ -739,6 +857,13 @@ static void prv_initiate_bootstrap(lwm2m_context_t * lwm2mH,
}
}

/**
* @brief Displays the backup of security and server objects.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_display_backup(lwm2m_context_t * lwm2mH,
char * buffer,
void * user_data)
Expand Down Expand Up @@ -768,6 +893,11 @@ static void prv_display_backup(lwm2m_context_t * lwm2mH,
}
}

/**
* @brief Backs up the content of security and server objects.
*
* @param context Pointer to the LWM2M context.
*/
static void prv_backup_objects(lwm2m_context_t * context)
{
uint16_t i;
Expand Down Expand Up @@ -799,6 +929,11 @@ static void prv_backup_objects(lwm2m_context_t * context)
copy_server_object(backupObjectArray[1], (lwm2m_object_t *)LWM2M_LIST_FIND(context->objectList, LWM2M_SERVER_OBJECT_ID));
}

/**
* @brief Restores the content of security and server objects from backup.
*
* @param context Pointer to the LWM2M context.
*/
static void prv_restore_objects(lwm2m_context_t * context)
{
lwm2m_object_t * targetP;
Expand All @@ -822,6 +957,12 @@ static void prv_restore_objects(lwm2m_context_t * context)
fprintf(stdout, "[BOOTSTRAP] ObjectList restored\r\n");
}

/**
* @brief Updates the bootstrap information based on changes in the context state.
*
* @param previousBootstrapState Pointer to the previous bootstrap state.
* @param context Pointer to the LWM2M context.
*/
static void update_bootstrap_info(lwm2m_client_state_t * previousBootstrapState,
lwm2m_context_t * context)
{
Expand All @@ -842,6 +983,9 @@ static void update_bootstrap_info(lwm2m_client_state_t * previousBootstrapState,
}
}

/**
* @brief Closes backup objects by cleaning up and freeing memory.
*/
static void close_backup_object(void) {
int i;
for (i = 0; i < BACKUP_OBJECT_COUNT; i++) {
Expand All @@ -864,6 +1008,13 @@ static void close_backup_object(void) {
}
#endif

/**
* @brief Displays the objects present in the LWM2M context.
*
* @param lwm2mH Pointer to the LWM2M context.
* @param buffer Pointer to a character buffer.
* @param user_data Unused parameter.
*/
static void prv_display_objects(lwm2m_context_t *lwm2mH, char *buffer, void *user_data) {
lwm2m_object_t *object;

Expand Down Expand Up @@ -905,6 +1056,9 @@ static void prv_display_objects(lwm2m_context_t *lwm2mH, char *buffer, void *use
}
}

/**
* @brief Prints usage instructions for the LWM2M client.
*/
void print_usage(void)
{
fprintf(stdout, "Usage: lwm2mclient [OPTION]\r\n");
Expand All @@ -927,21 +1081,28 @@ void print_usage(void)
fprintf(stdout, "\r\n");
}

/**
* @brief Main function.
*
* @param argc Argument count - number of arguments.
* @param argv Argument vector.
* @return Execution status.
*/
int main(int argc, char *argv[])
{
client_data_t data;
int result;
lwm2m_context_t * lwm2mH = NULL;
const char * localPort = "56830";
const char * server = NULL;
const char * serverPort = LWM2M_STANDARD_PORT_STR;
const char *name = "testlwm2mclient";
int lifetime = 300;
int batterylevelchanging = 0;
time_t reboot_time = 0;
int opt;
bool bootstrapRequested = false;
bool serverPortChanged = false;
client_data_t data; // Structure for client data
ssalkic marked this conversation as resolved.
Show resolved Hide resolved
int result; // Variable to store the result of operations
lwm2m_context_t * lwm2mH = NULL; // Pointer to LWM2M context
const char * localPort = "56830"; // Default local UDP port
const char * server = NULL; // Pointer to server address
const char * serverPort = LWM2M_STANDARD_PORT_STR; // Default server port
const char *name = "testlwm2mclient"; // Default client name
int lifetime = 300; // Default client lifetime
int batterylevelchanging = 0; // Flag to indicate battery level change
time_t reboot_time = 0; // Time for rebooting
int opt; // Variable for command line options
bool bootstrapRequested = false; // Flag to indicate bootstrap request
bool serverPortChanged = false; // Flag to indicate if server port is changed

#ifdef LWM2M_BOOTSTRAP
lwm2m_client_state_t previousState = STATE_INITIAL;
Expand Down
Loading
Loading