The PSS framework supports instruction sets that operate on the internal health of the framework.
These instructions include framework plug-in management, worker thread state management, framework basic parameter query, connection number list, server port management, IP management, and so on.
Command format:
ezample:
b freeeyes ShowServerInfo -a&
b: The output is output as a binary result, and if you want to output as a text structure, you can use **( for example, under telnet )
freeeyes: Username, this is required, the PSS framework will verify the user, specific verification settings in **main.xml **(set username) and **consolecommand.xml **( set corresponding permissions ) have permissions to be executed.
ShowServerInfo: Command name.
-a: Command params.
&: Command terminator is required.
##2.Support command introduction (Returns as a binary result output)
| Command sample | Explain | Returns the data structure | |
|---|---|---|---|
| ShowServerInfo -a | Obtain the basic operating parameters of the framework | Type | Explain |
| uint16 | Return command ID | ||
| uint16 | Server ID | ||
| uint8 | Server name length | ||
| char | Server name | ||
| uint8 | Server version code length | ||
| char | Server version code | ||
| uint16 | Server logic plugin count | ||
| uint16 | Server work thread count | ||
| uint16 | Server packet version | ||
| uint8 | Server word order large or small, 0 small 1 large | ||
| uint8 | Server word sequence 0 host sequence 1 network sequence | ||
| ShowModule -a | View all the plug-ins that the framework is running | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Number of plug-ins currently running | ||
| uint8 | Plug - in filename length | ||
| char | Plug - in file name | ||
| uint8 | Plug - in name length | ||
| char | Plug - in name | ||
| uint8 | Plug - in path length | ||
| char | Plug - in path | ||
| uint8 | Plug - in startup parameter length | ||
| char | Plug - in startup parameter | ||
| uint8 | Plug - in description length | ||
| char | Plug - in description | ||
| uint8 | Plug - in load time length | ||
| char | Plug - in load time | ||
| uint8 | Plug - in current running status word 0 is ok | ||
| uint32 | Plug - in currently running error code 0 is ok | ||
| LoadModule ./,TcpTest.so,Param | Load a plug - in, tcptest.so is the file name,. / is the path of the plug-in on the server, param is the plug-in startup parameter | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Plugin startup result 0 succeeded 1 failed | ||
| UnLoadModule TestTcp | Uninstall a plug - in, testtcp is the plug-in 's own name ( note that it is not a file name, it is a name set inside the plug - in ) | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Plugin startup result 0 succeeded 1 failed | ||
| ReLoadModule TestTcp | Reload a plug - in, testtcp is the plug-in 's own name ( note that it is not a file name, it is a name set inside the plug - in ) | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Plugin startup result 0 succeeded 1 failed | ||
| ClientCount -cp | Current number of client connections | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of current client connections | ||
| uint32 | Current total number of client connection pool remaining | ||
| uint32 | Total number of current client connection pools | ||
| CommandInfo 0x1000 | Query the specified message information, 0x1000 for message hexadecimal id | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Number of message | ||
| uint16 | Current number of message | ||
| uint16 | Message id | ||
| uint32 | Message execute counts | ||
| uint64 | Total time that Message has been performed,In seconds | ||
| CommandTimeout -a | Query all timeout message lists | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Timeout message count | ||
| uint16 | Timeout message ID | ||
| uint32 | Timeout message occurrence | ||
| uint32 | Timeout message run times | ||
| CommandTimeoutclr -a | Clear the timeout message list | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| CommandDataLog -a | save CommandDataLog | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| WorkThreadState -s | View worker thread status | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Work thread count | ||
| uint8 | Work thread ID | ||
| uint32 | The last run time of the worker thread, in the format 1970-01-01 to the current second value | ||
| uint32 | Worker thread start time, in the format 1970-01-01 to the current seconds | ||
| uint8 | Current state of worker thread | ||
| uint32 | 工Total number packets currently processed by work thread | ||
| uint16 | The message id that that worker thread is currently run | ||
| uint16 | Average packet processing time, in milliseconds, for worker threads | ||
| uint16 | Number of packets processed by worker threads in the last minute | ||
| ConnectClient -a | Information for the current TCP client link | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of current connections | ||
| uint8 | Connection name string length | ||
| char | Connection name string, the default is the connection of the client IP, can also be set | ||
| uint32 | Connect ID | ||
| uint32 | Connect recv packet counts | ||
| uint32 | Connect send packet counts | ||
| uint32 | Connect recv packet sizes | ||
| uint32 | Connect send packet sizes | ||
| uint32 | Connection creation time, in the format 1970-01-01 to the current second value | ||
| uint32 | Connection active time in seconds | ||
| uint32 | Total number of connection receive queue packets | ||
| uint64 | Total connection reception elapsed time | ||
| uint64 | Total elapsed time for connection transmission | ||
| UDPConnectClient -a | Information for the current UDP client link | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of current connections | ||
| uint8 | Connection name string length | ||
| char | Connection name string, the default is the connection of the client IP, can also be set | ||
| uint32 | Connect ID | ||
| uint32 | Connect recv packet counts | ||
| uint32 | Connect send packet counts | ||
| uint32 | Connect recv packet sizes | ||
| uint32 | Connect send packet sizes | ||
| uint32 | Connection creation time, in the format 1970-01-01 to the current second value | ||
| uint32 | Connection active time in seconds | ||
| uint32 | Total number of connection receive queue packets | ||
| uint64 | Total connection reception elapsed time | ||
| uint64 | Total elapsed time for connection transmission | ||
| CloseClient 1 | The client connection 1 that closes the specified connectid is connectid | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| ForbiddenIP -c 127.0.0.2 -t 1 -s 30 | Disable the specified IP connection server, - c is IP, - t is type0 temporary 1 permanent - s is the blocking time, in seconds | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| ShowForbiddenIP -a | View the banned IP list | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | banned IP counts | ||
| uint8 | banned IP length | ||
| char | banned IP | ||
| uint8 | banned IP type 0 temporary 1 permanent | ||
| uint32 | Block start time, in the format 1970-01-01 to the current seconds | ||
| uint32 | Blocked seconds | ||
| LiftedIP 127.0.0.2 | Unblock IP | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| ServerConnectTCP -a | Inter - server communication ( TCP ) | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of connections between servers | ||
| uint8 | Remote server IP length | ||
| char | Remote server IP | ||
| uint8 | Connection current state 0 is connected 1 is not connected | ||
| uint32 | Connect ID | ||
| uint32 | Connect recv packet counts | ||
| uint32 | Connect send packet counts | ||
| uint32 | Connect recv packet sizes | ||
| uint32 | Connect send packet sizes | ||
| uint32 | Connection creation time, in the format 1970-01-01 to the current second value | ||
| uint32 | Connection active time in seconds | ||
| uint32 | Total number of connection receive queue packets | ||
| uint64 | Total connection reception elapsed time | ||
| uint64 | Total elapsed time for connection transmission | ||
| ServerConnectUDP -a | Inter - server communication ( UDP ) | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of connections between servers | ||
| uint8 | Remote server IP length | ||
| char | Remote server IP | ||
| uint8 | Connection current state 0 is connected 1 is not connected | ||
| uint32 | Connect ID | ||
| uint32 | Connect recv packet counts | ||
| uint32 | Connect send packet counts | ||
| uint32 | Connect recv packet sizes | ||
| uint32 | Connect send packet sizes | ||
| uint32 | Connection creation time, in the format 1970-01-01 to the current second value | ||
| uint32 | Connection active time in seconds | ||
| uint32 | Total number of connection receive queue packets | ||
| uint64 | Total connection reception elapsed time | ||
| uint64 | Total elapsed time for connection transmission | ||
| ShowCurrProcessInfo -a | View the current CPU, memory, and network health status of the server framework | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Cpu operation ratio | ||
| uint32 | Current number of memory bytes occupied | ||
| uint8 | Flow switch status, 0 is off, 1 is on | ||
| uint32 | Server network throughput for the current minute(in) | ||
| uint32 | Server network throughput for the current minute(out) | ||
| ShowAllCommand -a | View all message run information | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Total number of message | ||
| uint8 | Module name length | ||
| char | Module name | ||
| uint16 | Message ID | ||
| uint32 | Total current message processing | ||
| uint32 | Total current message processing time, in milliseconds | ||
| ReConnectServer -s 172.0.10.1 | Reconnect remote connection - s IP address of the remote server | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| SetDebug -s 0 | Set debug file output status -s 0 on 1 off | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| ShowDebug -a | Query debug file output status -s 0 on 1 off | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | 0 open 1 close | ||
| GetConnectIPInfo -s 1 | The relevant IP information 1 obtain through that connectid is the connectid | Type | Explain |
| uint16 | Return command ID | ||
| uint16 | 0The corresponding IP information 1 was found and no corresponding IP information was found | ||
| uint8 | Current IP description length | ||
| char | Current IP description | ||
| uint32 | IP port | ||
| GetLogInfo -a | Get current log information | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Number of logs | ||
| uint32 | Current log level | ||
| uint16 | Log ID | ||
| uint8 | Server name length | ||
| char | Server name | ||
| uint8 | Log name length | ||
| char | Log name | ||
| uint8 | Log output type 0 write file 1 write screen | ||
| SetLogLevel -l 1 | Set the log level -1 for level 1 or higher logs are not output | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| GetWorkThreadAI -a | Get AI configuration information for thread | Type | Explain |
| uint16 | Return command ID | ||
| uint16 | Current number of threads | ||
| uint32 | Work thread ID | ||
| uint8 | AI status 0 close 1 open | ||
| uint32 | Message packet dispose timeout seconds | ||
| uint32 | work thread timeout,in seconds | ||
| uint32 | work thread timeout counts limited | ||
| uint32 | stop message dispose time,in second | ||
| GetWorkThreadTO -a | Gets all timeout packet information for thread | Type | Explain |
| uint16 | Return command ID | ||
| uint16 | Current number of threads | ||
| uint32 | Work thread ID | ||
| uint16 | timeout message ID | ||
| uint32 | Timeout current time, in seconds since 1970-01-01 | ||
| uint32 | Command execution time, in milliseconds | ||
| SetWorkThreadAI -i 1,1000,2000,10 | Set the configuration information for threadai, 1 to on, 1000 processing time limit 2000 check time limit 10 times to stop | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| GetNickNameInfo -n 127.0.0.1 | Obtain client IP information through IP alias | Type | Explain |
| uint32 | IP counts | ||
| uint32 | Corresponding commandid | ||
| uint8 | IP length | ||
| char | IP | ||
| uint32 | IP port | ||
| uint8 | Alias length | ||
| char | Alias | ||
| uint8 | Does the front connection log open 0 not open 1 open | ||
| SetConnectLog -n 1 -f 0 | Set connection log on state - n is connectid - f is 0 on 1 off | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| SetMaxConnectCount -n 20000 | Sets the maximum number of connections allowed for the current server - n is the number of connections | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| AddListen -i 127.0.0.1 -p 10003 -t 1 -n 1 | Dynamically open a new listening port -i ip -p port -t 1 tcp 2 udp -n corresponding packet parseid on the server | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| DelListen -i 127.0.0.1 -p 10003 -t 1 | Dynamically shut down the listening port -i ip -p port -t 1 tcp 2 udp on the server | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| ShowListen -a | View existing open server port information | Type | Explain |
| uint16 | Return command ID | ||
| uint32 | Number of listeners | ||
| uint8 | IP length | ||
| char | IP | ||
| uint32 | IP port | ||
| TestFileStart -f a.xml | Execute file pressure measurement instruction - f specifies the pressure measurement file name | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| TestFileStop -a | Stop file pressure measurement | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| SetTrackIP -i 127.0.0.1 -c 5 | Dyes the data for the specified client IP, -i is the client IP, -c is the number of dyed packets | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded | ||
| SetTrackCommand -i 0x1000 -c 5 | Dyes the data for the specified message id, -i message id in the format 0xxxxxx, -c is the number of dyed packets | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Execution state 0 succeeded，1 failed | ||
| GetTrackCommandInfo -a | View the message execution information for the current dye | Type | Explain |
| uint16 | Return command ID | ||
| uint8 | Current number of message | ||
| uint16 | messageID | ||
| uint16 | Number of currently dyed message ( processed ) | ||
| uint16 | Total number of dyes required for message | ||