japi_pushsrv_intern.h File Reference

Internal functions of the JSON API push servicelibrary. More...

#include <json-c/json.h>

Include dependency graph for japi_pushsrv_intern.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	japi_pushsrv_subscribe (japi_context *ctx, json_object *jreq, json_object *jresp)
	Subscribe a registered JAPI push service. More...
void	japi_pushsrv_unsubscribe (japi_context *ctx, json_object *jreq, json_object *jresp)
	Unsubscribe a registered JAPI push service. More...
void	japi_pushsrv_list (japi_context *ctx, json_object *request, json_object *response)
	List registered JAPI push services as JAPI response. More...

Detailed Description

Internal functions of the JSON API push servicelibrary.

Author

Deniz Armagan

Date

2019-06-12

Version

0.1

libjapi is a universal JSON API library.

Copyright

Copyright (c) 2023 Fraunhofer IIS

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Function Documentation

void japi_pushsrv_list	(	japi_context *	ctx,
		json_object *	request,
		json_object *	response
	)

List registered JAPI push services as JAPI response.

Provides the names of all registered push-services as a JAPI response.

Parameters

ctx	JAPI context
request	Pointer to JAPI JSON request
response	Pointer to JAPI JSON response

Note

Parameter 'request' declared, although not used in function. Function declaration needs to be identical to respective handler.

References japi_pushsrv_context::next, japi_context::push_services, and japi_pushsrv_context::pushsrv_name.

Referenced by japi_init().

void japi_pushsrv_subscribe	(	japi_context *	ctx,
		json_object *	jreq,
		json_object *	jresp
	)

Subscribe a registered JAPI push service.

Subscribe a registered JAPI push service specified by pushsrv_name.

Parameters

ctx	JAPI context
jreq	Request JSON object
jresp	Response JSON object

References japi_pushsrv_context::next, japi_context::push_services, and japi_pushsrv_context::pushsrv_name.

Referenced by japi_init().

void japi_pushsrv_unsubscribe	(	japi_context *	ctx,
		json_object *	jreq,
		json_object *	jresp
	)

Unsubscribe a registered JAPI push service.

Unsubscribe a registered JAPI push service specified by pushsrv_name.

Parameters

ctx	JAPI context
jreq	Request JSON object
jresp	Response JSON object

References japi_pushsrv_remove_client(), japi_pushsrv_context::next, japi_context::push_services, and japi_pushsrv_context::pushsrv_name.

Referenced by japi_init().