summaryrefslogtreecommitdiff
path: root/src/lib/ecore_ipc
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-15 16:30:18 -0800
committerCedric BAIL <cedric@osg.samsung.com>2017-02-15 16:30:22 -0800
commit5d389a1df64b93d4c10e25d98478526293435602 (patch)
treec9a821bee6cbafeca43907fb12d130c1b921e4a8 /src/lib/ecore_ipc
parent48627996d767b72aef15c33eea5a95c804525a01 (diff)
doxygen: fix typos and some wrong expressions in API reference.
Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in API reference doxygen. Test Plan: Doxygen revision Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4658 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/ecore_ipc')
-rw-r--r--src/lib/ecore_ipc/Ecore_Ipc.h50
1 files changed, 25 insertions, 25 deletions
diff --git a/src/lib/ecore_ipc/Ecore_Ipc.h b/src/lib/ecore_ipc/Ecore_Ipc.h
index e7f3222885..be776f40f1 100644
--- a/src/lib/ecore_ipc/Ecore_Ipc.h
+++ b/src/lib/ecore_ipc/Ecore_Ipc.h
@@ -327,18 +327,18 @@ EAPI extern int ECORE_IPC_EVENT_CLIENT_DATA;
327EAPI extern int ECORE_IPC_EVENT_SERVER_DATA; 327EAPI extern int ECORE_IPC_EVENT_SERVER_DATA;
328 328
329/** 329/**
330 * @brief Initialises the Ecore IPC library. 330 * @ingroup Ecore_IPC_Group
331 * @brief Initializes the Ecore IPC library.
331 * @return Number of times the library has been initialised without 332 * @return Number of times the library has been initialised without
332 * being shut down. 333 * being shut down.
333 * @ingroup Ecore_IPC_Group
334 */ 334 */
335EAPI int ecore_ipc_init(void); 335EAPI int ecore_ipc_init(void);
336 336
337/** 337/**
338 * @ingroup Ecore_IPC_Group
338 * @brief Shuts down the Ecore IPC library. 339 * @brief Shuts down the Ecore IPC library.
339 * @return Number of times the library has been initialised without being 340 * @return Number of times the library has been initialised without being
340 * shut down. 341 * shut down.
341 * @ingroup Ecore_IPC_Group
342 */ 342 */
343EAPI int ecore_ipc_shutdown(void); 343EAPI int ecore_ipc_shutdown(void);
344 344
@@ -350,6 +350,7 @@ EAPI int ecore_ipc_shutdown(void);
350 */ 350 */
351 351
352/** 352/**
353 * @ingroup Ecore_IPC_Server_Group
353 * @brief Creates an IPC server that listens for connections. 354 * @brief Creates an IPC server that listens for connections.
354 * 355 *
355 * For more details about the @p compl_type, @p name and @p port 356 * For more details about the @p compl_type, @p name and @p port
@@ -360,12 +361,12 @@ EAPI int ecore_ipc_shutdown(void);
360 * @param port Number to identify with socket used for connection. 361 * @param port Number to identify with socket used for connection.
361 * @param data Data to associate with the IPC server. 362 * @param data Data to associate with the IPC server.
362 * @return New IPC server. If there is an error, @c NULL is returned. 363 * @return New IPC server. If there is an error, @c NULL is returned.
363 * @ingroup Ecore_IPC_Server_Group
364 * @todo Need to add protocol type parameter to this function. 364 * @todo Need to add protocol type parameter to this function.
365 */ 365 */
366EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *name, int port, const void *data); 366EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *name, int port, const void *data);
367 367
368/** 368/**
369 * @ingroup Ecore_IPC_Server_Group
369 * @brief Creates an IPC server object to represent the IPC server listening 370 * @brief Creates an IPC server object to represent the IPC server listening
370 * on the given port. 371 * on the given port.
371 * 372 *
@@ -379,44 +380,44 @@ EAPI Ecore_Ipc_Server *ecore_ipc_server_add(Ecore_Ipc_Type type, const char *nam
379 * IPC connection. 380 * IPC connection.
380 * @param data Data to associate with the server. 381 * @param data Data to associate with the server.
381 * @return A new IPC server. @c NULL is returned on error. 382 * @return A new IPC server. @c NULL is returned on error.
382 * @ingroup Ecore_IPC_Server_Group
383 * @todo Need to add protocol type parameter. 383 * @todo Need to add protocol type parameter.
384 */ 384 */
385EAPI Ecore_Ipc_Server *ecore_ipc_server_connect(Ecore_Ipc_Type type, char *name, int port, const void *data); 385EAPI Ecore_Ipc_Server *ecore_ipc_server_connect(Ecore_Ipc_Type type, char *name, int port, const void *data);
386 386
387/** 387/**
388 * @ingroup Ecore_IPC_Server_Group
388 * @brief Closes the connection and frees the given IPC server. 389 * @brief Closes the connection and frees the given IPC server.
389 * @param svr The given IPC server. 390 * @param svr The given IPC server.
390 * @return The data associated with the server when it was created. 391 * @return The data associated with the server when it was created.
391 * @ingroup Ecore_IPC_Server_Group
392 */ 392 */
393EAPI void *ecore_ipc_server_del(Ecore_Ipc_Server *svr); 393EAPI void *ecore_ipc_server_del(Ecore_Ipc_Server *svr);
394 394
395/** 395/**
396 * @ingroup Ecore_IPC_Server_Group
396 * @brief Retrieves the data associated with the given IPC server. 397 * @brief Retrieves the data associated with the given IPC server.
397 * @param svr The given IPC server. 398 * @param svr The given IPC server.
398 * @return The associated data. 399 * @return The associated data.
399 * @ingroup Ecore_IPC_Server_Group
400 */ 400 */
401EAPI void *ecore_ipc_server_data_get(Ecore_Ipc_Server *svr); 401EAPI void *ecore_ipc_server_data_get(Ecore_Ipc_Server *svr);
402 402
403/** 403/**
404 * @ingroup Ecore_IPC_Server_Group
404 * @brief Retrieves whether the given IPC server is currently connected. 405 * @brief Retrieves whether the given IPC server is currently connected.
405 * @param svr The given IPC server. 406 * @param svr The given IPC server.
406 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. 407 * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise.
407 * @ingroup Ecore_IPC_Server_Group
408 */ 408 */
409EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr); 409EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr);
410 410
411/** 411/**
412 * @ingroup Ecore_IPC_Server_Group
412 * @brief Retrieves the list of clients for this server. 413 * @brief Retrieves the list of clients for this server.
413 * @param svr The given IPC server. 414 * @param svr The given IPC server.
414 * @return An Eina_List with the clients. 415 * @return An Eina_List with the clients.
415 * @ingroup Ecore_IPC_Server_Group
416 */ 416 */
417EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr); 417EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
418 418
419/** 419/**
420 * @ingroup Ecore_IPC_Server_Group
420 * @brief Sends a message to the given IPC server. 421 * @brief Sends a message to the given IPC server.
421 * 422 *
422 * The content of the parameters, excluding the @p svr parameter, is up to 423 * The content of the parameters, excluding the @p svr parameter, is up to
@@ -431,13 +432,13 @@ EAPI Eina_List *ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr);
431 * @param data The data to send as part of the message. 432 * @param data The data to send as part of the message.
432 * @param size Length of the data, in bytes, to send. 433 * @param size Length of the data, in bytes, to send.
433 * @return Number of bytes sent. @c 0 is returned if there is an error. 434 * @return Number of bytes sent. @c 0 is returned if there is an error.
434 * @ingroup Ecore_IPC_Server_Group
435 * @todo This function needs to become an IPC message. 435 * @todo This function needs to become an IPC message.
436 * @todo Fix up the documentation: Make sure what ref_to and response are. 436 * @todo Fix up the documentation: Make sure what ref_to and response are.
437 */ 437 */
438EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size); 438EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
439 439
440/** 440/**
441 * @ingroup Ecore_IPC_Server_Group
441 * @brief Sets a limit on the number of clients that can be handled concurrently 442 * @brief Sets a limit on the number of clients that can be handled concurrently
442 * by the given server, and a policy on what to do if excess clients try to 443 * by the given server, and a policy on what to do if excess clients try to
443 * connect. 444 * connect.
@@ -457,29 +458,29 @@ EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, i
457 * drops. This causes the kernel to queue up to 4096 458 * drops. This causes the kernel to queue up to 4096
458 * connections (or your kernel's limit, whichever is 459 * connections (or your kernel's limit, whichever is
459 * lower). 460 * lower).
460 * @ingroup Ecore_IPC_Server_Group
461 */ 461 */
462EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients); 462EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients);
463 463
464/** 464/**
465 * @ingroup Ecore_IPC_Server_Group
465 * @brief Sets the max data payload size for an Ipc message in bytes 466 * @brief Sets the max data payload size for an Ipc message in bytes
466 * 467 *
467 * @param svr The given server. 468 * @param svr The given server.
468 * @param size The maximum data payload size in bytes. 469 * @param size The maximum data payload size in bytes.
469 * @ingroup Ecore_IPC_Server_Group
470 */ 470 */
471EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *srv, int size); 471EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *srv, int size);
472 472
473/** 473/**
474 * @ingroup Ecore_IPC_Server_Group
474 * @brief Gets the max data payload size for an Ipc message in bytes 475 * @brief Gets the max data payload size for an Ipc message in bytes
475 * 476 *
476 * @param svr The given server. 477 * @param svr The given server.
477 * @return The maximum data payload in bytes. 478 * @return The maximum data payload in bytes.
478 * @ingroup Ecore_IPC_Server_Group
479 */ 479 */
480EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv); 480EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv);
481 481
482/** 482/**
483 * @ingroup Ecore_IPC_Server_Group
483 * @brief Gets the IP address of a server that has been connected to. 484 * @brief Gets the IP address of a server that has been connected to.
484 * 485 *
485 * @param svr The given server. 486 * @param svr The given server.
@@ -487,15 +488,14 @@ EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *srv)
487 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation. 488 * the connected server in the form "XXX.YYY.ZZZ.AAA" IP notation.
488 * This string should not be modified or trusted to stay valid after 489 * This string should not be modified or trusted to stay valid after
489 * deletion for the @p svr object. If no IP is known NULL is returned. 490 * deletion for the @p svr object. If no IP is known NULL is returned.
490 * @ingroup Ecore_IPC_Server_Group
491 */ 491 */
492EAPI const char *ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr); 492EAPI const char *ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr);
493 493
494/** 494/**
495 * @ingroup Ecore_IPC_Server_Group
495 * @brief Flushes all pending data to the given server. Will return when done. 496 * @brief Flushes all pending data to the given server. Will return when done.
496 * 497 *
497 * @param svr The given server. 498 * @param svr The given server.
498 * @ingroup Ecore_IPC_Server_Group
499 */ 499 */
500EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr); 500EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
501 501
@@ -507,6 +507,7 @@ EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
507 */ 507 */
508 508
509/** 509/**
510 * @ingroup Ecore_IPC_Client_Group
510 * @brief Sends a message to the given IPC client. 511 * @brief Sends a message to the given IPC client.
511 * 512 *
512 * @param cl The given IPC client. 513 * @param cl The given IPC client.
@@ -519,68 +520,68 @@ EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr);
519 * @param size Length of the data, in bytes, to send. 520 * @param size Length of the data, in bytes, to send.
520 * @return The number of bytes sent. @c 0 will be returned if there is 521 * @return The number of bytes sent. @c 0 will be returned if there is
521 * an error. 522 * an error.
522 * @ingroup Ecore_IPC_Client_Group
523 * @todo This function needs to become an IPC message. 523 * @todo This function needs to become an IPC message.
524 * @todo Make sure ref_to and response parameters are described correctly. 524 * @todo Make sure ref_to and response parameters are described correctly.
525 */ 525 */
526EAPI int ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size); 526EAPI int ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size);
527 527
528/** 528/**
529 * @ingroup Ecore_IPC_Client_Group
529 * @brief Retrieves the IPC server that the given IPC client is connected to. 530 * @brief Retrieves the IPC server that the given IPC client is connected to.
530 * 531 *
531 * @param cl The given IPC client. 532 * @param cl The given IPC client.
532 * @return The IPC server the IPC client is connected to. 533 * @return The IPC server the IPC client is connected to.
533 * @ingroup Ecore_IPC_Client_Group
534 */ 534 */
535EAPI Ecore_Ipc_Server *ecore_ipc_client_server_get(Ecore_Ipc_Client *cl); 535EAPI Ecore_Ipc_Server *ecore_ipc_client_server_get(Ecore_Ipc_Client *cl);
536 536
537/** 537/**
538 * @ingroup Ecore_IPC_Client_Group
538 * @brief Closes the connection and frees memory allocated to the given IPC 539 * @brief Closes the connection and frees memory allocated to the given IPC
539 * client. 540 * client.
540 * 541 *
541 * @param cl The given client. 542 * @param cl The given client.
542 * @return Data associated with the client. 543 * @return Data associated with the client.
543 * @ingroup Ecore_IPC_Client_Group
544 */ 544 */
545EAPI void *ecore_ipc_client_del(Ecore_Ipc_Client *cl); 545EAPI void *ecore_ipc_client_del(Ecore_Ipc_Client *cl);
546 546
547/** 547/**
548 * @ingroup Ecore_IPC_Client_Group
548 * @brief Sets the IPC data associated with the given IPC client to @p data. 549 * @brief Sets the IPC data associated with the given IPC client to @p data.
549 * 550 *
550 * @param cl The given IPC client. 551 * @param cl The given IPC client.
551 * @param data The data to associate with the IPC client. 552 * @param data The data to associate with the IPC client.
552 * @ingroup Ecore_IPC_Client_Group
553 */ 553 */
554EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data); 554EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data);
555 555
556/** 556/**
557 * @ingroup Ecore_IPC_Client_Group
557 * @brief Retrieves the data that has been associated with the given IPC client. 558 * @brief Retrieves the data that has been associated with the given IPC client.
558 * 559 *
559 * @param cl The given client. 560 * @param cl The given client.
560 * @return The data associated with the IPC client. 561 * @return The data associated with the IPC client.
561 * @ingroup Ecore_IPC_Client_Group
562 */ 562 */
563EAPI void *ecore_ipc_client_data_get(Ecore_Ipc_Client *cl); 563EAPI void *ecore_ipc_client_data_get(Ecore_Ipc_Client *cl);
564 564
565/** 565/**
566 * @ingroup Ecore_IPC_Client_Group
566 * @brief Sets the max data payload size for an Ipc message in bytes 567 * @brief Sets the max data payload size for an Ipc message in bytes
567 * 568 *
568 * @param cl The given client. 569 * @param cl The given client.
569 * @param size The maximum data payload size in bytes. 570 * @param size The maximum data payload size in bytes.
570 * @ingroup Ecore_IPC_Client_Group
571 */ 571 */
572EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size); 572EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size);
573 573
574/** 574/**
575 * @ingroup Ecore_IPC_Client_Group
575 * @brief Gets the max data payload size for an Ipc message in bytes 576 * @brief Gets the max data payload size for an Ipc message in bytes
576 * 577 *
577 * @param cl The given client. 578 * @param cl The given client.
578 * @return The maximum data payload size in bytes on success, @c -1 on failure. 579 * @return The maximum data payload size in bytes on success, @c -1 on failure.
579 * @ingroup Ecore_IPC_Client_Group
580 */ 580 */
581EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl); 581EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
582 582
583/** 583/**
584 * @ingroup Ecore_IPC_Client_Group
584 * @brief Gets the IP address of a client that has been connected to. 585 * @brief Gets the IP address of a client that has been connected to.
585 * 586 *
586 * @param cl The given client. 587 * @param cl The given client.
@@ -589,23 +590,22 @@ EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl);
589 * This string should not be modified or trusted to stay valid after 590 * This string should not be modified or trusted to stay valid after
590 * deletion for the @p cl object. If no IP is known @c NULL is 591 * deletion for the @p cl object. If no IP is known @c NULL is
591 * returned. 592 * returned.
592 * @ingroup Ecore_IPC_Client_Group
593 */ 593 */
594EAPI const char *ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl); 594EAPI const char *ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl);
595 595
596/** 596/**
597 * @ingroup Ecore_IPC_Client_Group
597 * @brief Flushes all pending data to the given client. Will return when done. 598 * @brief Flushes all pending data to the given client. Will return when done.
598 * 599 *
599 * @param cl The given client. 600 * @param cl The given client.
600 * @ingroup Ecore_IPC_Client_Group
601 */ 601 */
602EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl); 602EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl);
603 603
604/** 604/**
605 * @ingroup Ecore_Con_Client_Group
605 * @brief Returns if SSL support is available 606 * @brief Returns if SSL support is available
606 * 607 *
607 * @return 1 if SSL is available, 0 if it is not. 608 * @return 1 if SSL is available, 0 if it is not.
608 * @ingroup Ecore_Con_Client_Group
609 */ 609 */
610EAPI int ecore_ipc_ssl_available_get(void); 610EAPI int ecore_ipc_ssl_available_get(void);
611/* FIXME: need to add a callback to "ok" large ipc messages greater than */ 611/* FIXME: need to add a callback to "ok" large ipc messages greater than */