package appctl

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetStatus (Empty, AppStatusMsg)

  rpc.proto:28

  Fetch client application status.

• rpc Exit (Empty, Empty)

  rpc.proto:31

  Quit client daemon.

• rpc GetMetrics (Empty, Metrics)

  rpc.proto:34

  Get client metrics.

• rpc GetSessionInfoList (Empty, SessionInfoList)

  rpc.proto:37

  Get client session information.

• rpc GetThreadDump (Empty, ThreadDump)

  rpc.proto:40

  Generate a thread dump of client daemon.

• rpc StartCPUProfile (ProfileSavePath, Empty)

  rpc.proto:43

  Start CPU profiling.

• rpc StopCPUProfile (Empty, Empty)

  rpc.proto:46

  Stop CPU profiling.

• rpc GetHeapProfile (ProfileSavePath, Empty)

  rpc.proto:49

  Generate a heap profile.

• rpc GetMemoryStatistics (Empty, MemoryStatistics)

  rpc.proto:52

  Get memory statistics of client daemon.

• rpc GetStatus (Empty, AppStatusMsg)

  rpc.proto:57

  Fetch server application status.

• rpc Start (Empty, Empty)

  rpc.proto:60

  Start proxy in server application.

• rpc Stop (Empty, Empty)

  rpc.proto:63

  Stop proxy in server application.

• rpc GetConfig (Empty, ServerConfig)

  rpc.proto:66

  Fetch the server config.

• rpc SetConfig (ServerConfig, ServerConfig)

  rpc.proto:69

  Update server config.

• rpc Reload (Empty, Empty)

  rpc.proto:72

  Reload server configuration.

• rpc Exit (Empty, Empty)

  rpc.proto:75

  Quit server daemon.

• rpc GetMetrics (Empty, Metrics)

  rpc.proto:78

  Get server metrics.

• rpc GetSessionInfoList (Empty, SessionInfoList)

  rpc.proto:81

  Get server session information.

• rpc GetUsers (Empty, UserWithMetricsList)

  rpc.proto:84

  Get users setting and runtime information.

  message UserWithMetricsList

  misc.proto:39

  • repeated UserWithMetrics items = 1

• rpc GetThreadDump (Empty, ThreadDump)

  rpc.proto:87

  Generate a thread dump of server daemon.

• rpc StartCPUProfile (ProfileSavePath, Empty)

  rpc.proto:90

  Start CPU profiling.

• rpc StopCPUProfile (Empty, Empty)

  rpc.proto:93

  Stop CPU profiling.

• rpc GetHeapProfile (ProfileSavePath, Empty)

  rpc.proto:96

  Generate a heap profile.

• rpc GetMemoryStatistics (Empty, MemoryStatistics)

  rpc.proto:99

  Get memory statistics of server daemon.

Used in: AppStatusMsg

• UNKNOWN = 0

• IDLE = 1

  RPC service is available, but proxy is not started.

• STARTING = 2

  Proxy is starting.

• RUNNING = 3

  Proxy is running.

• STOPPING = 4

  Proxy is being stopped.

Used as response type in: ClientManagementService.GetStatus, ServerManagementService.GetStatus

• optional AppStatus status = 1

Used in: ClientConfig, EgressProxy

• optional string user = 1

  Username used for authentication.

• optional string password = 2

  Password used for authentication.

Used in: ClientConfig

• optional bool noCheckUpdate = 1

  Do not check update when client is started.

• repeated ClientProfile profiles = 1

  A list of known client profiles.

• optional string activeProfile = 2

  The active profile name.

• optional int32 rpcPort = 3

  The management RPC port that client is listening in localhost.

• optional int32 socks5Port = 4

  The socks5 port that mieru is listening.

• optional ClientAdvancedSettings advancedSettings = 5

  Client advanced settings.

• optional LoggingLevel loggingLevel = 6

  Client logging level.

• optional bool socks5ListenLAN = 7

  If set, the socks5 port listens to LAN rather than localhost.

• optional int32 httpProxyPort = 8

  The port mieru is listening to provide HTTP / HTTPS proxy.

• optional bool httpProxyListenLAN = 9

  If set, the HTTP proxy port listens to LAN rather than localhost.

• repeated Auth socks5Authentication = 10

  A list of accounts that can authenticate mieru socks5 proxy service. If the list is empty, authentication is not required.

Used in: ClientConfig

• optional string profileName = 1

  Client profile name.

• optional User user = 2

  User information.

• repeated ServerEndpoint servers = 3

  A list of servers to connect.

• optional int32 mtu = 4

  Maximum transmission unit of L2 payload. This setting only applies to UDP protocol egress traffic.

• optional MultiplexingConfig multiplexing = 5

  Multiplexing behaviors.

Used in: ServerConfig

• optional DualStack dualStack = 1

  Pick up IP address from IP version preference.

Used in: DNS

• USE_FIRST_IP = 0

• PREFER_IPv4 = 1

• PREFER_IPv6 = 2

• ONLY_IPv4 = 3

• ONLY_IPv6 = 4

Used in: ServerConfig

• repeated EgressProxy proxies = 1

  A list of proxies.

• repeated EgressRule rules = 2

  A list of rules. If no rule is matched, the default action is DIRECT.

Used in: EgressRule

• PROXY = 0

  Use proxy to connect to the destination.

• DIRECT = 1

  Directly connect to the destination.

• REJECT = 2

  Do not connect to the destination.

Used in: Egress

• optional string name = 1

• optional ProxyProtocol protocol = 2

• optional string host = 3

  Proxy IP address or domain name.

• optional int32 port = 4

  Proxy port number.

• optional Auth socks5Authentication = 5

  Credential to authenticate egress socks5 proxy. If the proxy protocol is not socks5, this is ignored.

Used in: Egress

• repeated string ipRanges = 1

  A list of CIDR to match the rule. Use "*" to match all IP addresses.

• repeated string domainNames = 2

  A list of domain names to match the rule. Use "*" to match all domain names.

• optional EgressAction action = 3

  The action to do when the rule is matched.

• optional string proxyName = 4

  The name of proxy to connect. This is required when the action is PROXY.

Used as request type in: ClientManagementService.Exit, ClientManagementService.GetMemoryStatistics, ClientManagementService.GetMetrics, ClientManagementService.GetSessionInfoList, ClientManagementService.GetStatus, ClientManagementService.GetThreadDump, ClientManagementService.StopCPUProfile, ServerManagementService.Exit, ServerManagementService.GetConfig, ServerManagementService.GetMemoryStatistics, ServerManagementService.GetMetrics, ServerManagementService.GetSessionInfoList, ServerManagementService.GetStatus, ServerManagementService.GetThreadDump, ServerManagementService.GetUsers, ServerManagementService.Reload, ServerManagementService.Start, ServerManagementService.Stop, ServerManagementService.StopCPUProfile

Used as response type in: ClientManagementService.Exit, ClientManagementService.GetHeapProfile, ClientManagementService.StartCPUProfile, ClientManagementService.StopCPUProfile, ServerManagementService.Exit, ServerManagementService.GetHeapProfile, ServerManagementService.Reload, ServerManagementService.Start, ServerManagementService.StartCPUProfile, ServerManagementService.Stop, ServerManagementService.StopCPUProfile

(message has no fields)

Used in: ClientConfig, ServerConfig

• DEFAULT = 0

• FATAL = 1

• ERROR = 2

• WARN = 3

• INFO = 4

• DEBUG = 5

• TRACE = 6

Used as response type in: ClientManagementService.GetMemoryStatistics, ServerManagementService.GetMemoryStatistics

• optional uint64 heapBytes = 2

• optional uint64 heapObjects = 3

• optional uint64 maxHeapBytes = 4

• optional uint64 targetHeapBytes = 5

• optional uint64 stackBytes = 6

Used as response type in: ClientManagementService.GetMetrics, ServerManagementService.GetMetrics

• optional string json = 1

  JSON dump of metrics.

Used in: ClientProfile

• optional MultiplexingLevel level = 1

  How frequent a network connection is reused.

Used in: MultiplexingConfig

• MULTIPLEXING_DEFAULT = 0

• MULTIPLEXING_OFF = 1

• MULTIPLEXING_LOW = 2

• MULTIPLEXING_MIDDLE = 3

• MULTIPLEXING_HIGH = 4

Used in: ServerConfig, ServerEndpoint

• optional int32 port = 1

  A single port number. This field can't be set with portRange at the same time.

• optional TransportProtocol protocol = 2

• optional string portRange = 3

  A port number range. For example, "8000-9000" contains 1001 ports from 8000 to 9000. This field can't be set with port at the same time.

Used as request type in: ClientManagementService.GetHeapProfile, ClientManagementService.StartCPUProfile, ServerManagementService.GetHeapProfile, ServerManagementService.StartCPUProfile

• optional string filePath = 1

  Location to save profile results.

Used in: EgressProxy

• UNKNOWN_PROXY_PROTOCOL = 0

• SOCKS5_PROXY_PROTOCOL = 1

Used in: User

• optional int32 days = 1

  Number of days to renew the quota. The renew is rolling based.

• optional int32 megabytes = 2

  Number of megabytes the user allowed to send and receive.

Used in: ServerConfig

• optional bool allowLocalDestination = 1

  Allow using socks5 to access resources served in localhost. This option should be set to false unless required due to testing purpose.

Used as request type in: ServerManagementService.SetConfig

Used as response type in: ServerManagementService.GetConfig, ServerManagementService.SetConfig

• repeated PortBinding portBindings = 1

  Server's port-protocol bindings.

• repeated User users = 2

  A list of registered users.

• optional ServerAdvancedSettings advancedSettings = 3

  Server advanced settings.

• optional LoggingLevel loggingLevel = 4

  Server logging level.

• optional int32 mtu = 5

  Maximum transmission unit of L2 payload. This setting only applies to UDP protocol egress traffic.

• optional Egress egress = 6

  Egress proxies and rules.

• optional DNS dns = 7

  How to resolve IP address when the client send a request with a domain name.

Used in: ClientProfile

• optional string ipAddress = 1

  String representation of IP address. It can be either IPv4 or IPv6.

• optional string domainName = 2

  Server's full qualified domain name. When this is set, the `ipAddress` field is ignored.

• repeated PortBinding portBindings = 3

  Server's port-protocol bindings.

Used in: SessionInfoList

• optional string id = 1

• optional string protocol = 2

• optional string localAddr = 3

• optional string remoteAddr = 4

• optional string state = 5

• optional uint32 recvQ = 6

• optional uint32 recvBuf = 7

• optional uint32 sendQ = 8

• optional uint32 sendBuf = 9

• optional google.protobuf.Timestamp lastRecvTime = 10

• optional uint32 lastRecvSeq = 11

• optional google.protobuf.Timestamp lastSendTime = 12

• optional uint32 lastSendSeq = 13

Used as response type in: ClientManagementService.GetSessionInfoList, ServerManagementService.GetSessionInfoList

• repeated SessionInfo items = 1

Used as response type in: ClientManagementService.GetThreadDump, ServerManagementService.GetThreadDump

• optional string threadDump = 1

  Full thread dump of the application.

Used in: PortBinding

• UNKNOWN_TRANSPORT_PROTOCOL = 0

• UDP = 1

• TCP = 2

Used in: ClientProfile, ServerConfig, UserWithMetrics

• optional string name = 1

  User name is also the ID of user. Typically this is an email address.

• optional string password = 2

  Raw password. For safety this shouldn't be persisted at the server side.

• optional string hashedPassword = 3

  Hashed password. Stored with hex encoding.

• repeated Quota quotas = 4

  User quotas. This has no effect at the client side.

Used in: UserWithMetricsList

• optional User user = 1

  User information.

• repeated metrics.Metric metrics = 2

  User runtime information.