File: IPCClient.h

package info (click to toggle)
audacity 3.7.7%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 134,800 kB
  • sloc: cpp: 366,277; ansic: 198,323; lisp: 7,761; sh: 3,414; python: 1,501; xml: 1,385; perl: 854; makefile: 125
file content (42 lines) | stat: -rw-r--r-- 1,139 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/**********************************************************************

  Audacity: A Digital Audio Editor

  @file IPCClient.h

  @author Vitaly Sverchinsky

  Part of lib-ipc library

**********************************************************************/

#pragma once

#include <memory>

class IPCChannelStatusCallback;

/**
 * \brief Simple TCP socket based ipc client. When created
 * attempts to connect to existing server (see IPCServer). 
 */
class IPC_API IPCClient final
{
   class Impl;
   std::unique_ptr<Impl> mImpl;
public:
   /**
    * \brief Attempts to connect to a server, may fail with exception
    * or with call to IPCChannelStatusCallback::OnConnectionError.
    * Callback should be guaranteed to be alive
    * until either IPCChannelStatusCallback::OnDisconnect
    * or IPCChannelStatusCallback::OnConnectionError is called.
    * \param port TCP port number used to connect to server
    * \param callback Channel status callback. May be accessed from working threads.
    */
   IPCClient(int port, IPCChannelStatusCallback& callback);
   /**
    * \brief Closes connection if any.
    */
   ~IPCClient();
};