Refine typo in kernel.

2025-03-09 15:49:59 +00:00 · 2019-04-22 09:19:05 +08:00 · 2019-04-22 09:19:05 +08:00 · 35fe05d62c
commit 35fe05d62c
parent 735176cab4
9 changed files with 1321 additions and 1976 deletions
--- a/trunk/src/kernel/srs_kernel_consts.hpp
+++ b/trunk/src/kernel/srs_kernel_consts.hpp
@ -36,82 +36,72 @@
 ///////////////////////////////////////////////////////////
 // RTMP consts values
 ///////////////////////////////////////////////////////////
-// default vhost of rtmp
+// Default vhost of rtmp
 #define SRS_CONSTS_RTMP_DEFAULT_VHOST "__defaultVhost__"
 #define SRS_CONSTS_RTMP_DEFAULT_APP "__defaultApp__"
-// default port of rtmp
+// Default port of rtmp
 #define SRS_CONSTS_RTMP_DEFAULT_PORT 1935

-// the default chunk size for system.
+// The default chunk size for system.
 #define SRS_CONSTS_RTMP_SRS_CHUNK_SIZE 60000
 // 6. Chunking, RTMP protocol default chunk size.
 #define SRS_CONSTS_RTMP_PROTOCOL_CHUNK_SIZE 128

-/**
- * 6. Chunking
- * The chunk size is configurable. It can be set using a control
- * message(Set Chunk Size) as described in section 7.1. The maximum
- * chunk size can be 65536 bytes and minimum 128 bytes. Larger values
- * reduce CPU usage, but also commit to larger writes that can delay
- * other content on lower bandwidth connections. Smaller chunks are not
- * good for high-bit rate streaming. Chunk size is maintained
- * independently for each direction.
- */
+// 6. Chunking
+// The chunk size is configurable. It can be set using a control
+// message(Set Chunk Size) as described in section 7.1. The maximum
+// chunk size can be 65536 bytes and minimum 128 bytes. Larger values
+// reduce CPU usage, but also commit to larger writes that can delay
+// other content on lower bandwidth connections. Smaller chunks are not
+// good for high-bit rate streaming. Chunk size is maintained
+// independently for each direction.
 #define SRS_CONSTS_RTMP_MIN_CHUNK_SIZE 128
 #define SRS_CONSTS_RTMP_MAX_CHUNK_SIZE 65536


-// the following is the timeout for rtmp protocol,
+// The following is the timeout for rtmp protocol,
 // to avoid death connection.

-// the common io timeout, for connect, recv or send.
+// The common io timeout, for connect, recv or send.
 // TODO: FIXME: Maybe change to smaller value, such as 3s?
 #define SRS_CONSTS_RTMP_TIMEOUT (30 * SRS_UTIME_SECONDS)

-// the timeout to wait for client control message,
+// The timeout to wait for client control message,
 // if timeout, we generally ignore and send the data to client,
 // generally, it's the pulse time for data seding.
 // @remark, recomment to 500ms.
 #define SRS_CONSTS_RTMP_PULSE (500 * SRS_UTIME_MILLISECONDS)

-/**
- * max rtmp header size:
- *     1bytes basic header,
- *     11bytes message header,
- *     4bytes timestamp header,
- * that is, 1+11+4=16bytes.
- */
+// The max rtmp header size:
+//     1bytes basic header,
+//     11bytes message header,
+//     4bytes timestamp header,
+// that is, 1+11+4=16bytes.
 #define SRS_CONSTS_RTMP_MAX_FMT0_HEADER_SIZE 16
-/**
- * max rtmp header size:
- *     1bytes basic header,
- *     4bytes timestamp header,
- * that is, 1+4=5bytes.
- */
+// The max rtmp header size:
+//     1bytes basic header,
+//     4bytes timestamp header,
+// that is, 1+4=5bytes.
 // always use fmt0 as cache.
 #define SRS_CONSTS_RTMP_MAX_FMT3_HEADER_SIZE 5

-/**
- * for performance issue,
- * the iovs cache, @see https://github.com/ossrs/srs/issues/194
- * iovs cache for multiple messages for each connections.
- * suppose the chunk size is 64k, each message send in a chunk which needs only 2 iovec,
- * so the iovs max should be (SRS_PERF_MW_MSGS * 2)
- *
- * @remark, SRS will realloc when the iovs not enough.
- */
+// For performance issue,
+// the iovs cache, @see https://github.com/ossrs/srs/issues/194
+// iovs cache for multiple messages for each connections.
+// suppose the chunk size is 64k, each message send in a chunk which needs only 2 iovec,
+// so the iovs max should be (SRS_PERF_MW_MSGS * 2)
+//
+// @remark, SRS will realloc when the iovs not enough.
 #define SRS_CONSTS_IOVS_MAX (SRS_PERF_MW_MSGS * 2)
-/**
- * for performance issue,
- * the c0c3 cache, @see https://github.com/ossrs/srs/issues/194
- * c0c3 cache for multiple messages for each connections.
- * each c0 <= 16byes, suppose the chunk size is 64k,
- * each message send in a chunk which needs only a c0 header,
- * so the c0c3 cache should be (SRS_PERF_MW_MSGS * 16)
- *
- * @remark, SRS will try another loop when c0c3 cache dry, for we cannot realloc it.
- *       so we use larger c0c3 cache, that is (SRS_PERF_MW_MSGS * 32)
- */
+// For performance issue,
+// the c0c3 cache, @see https://github.com/ossrs/srs/issues/194
+// c0c3 cache for multiple messages for each connections.
+// each c0 <= 16byes, suppose the chunk size is 64k,
+// each message send in a chunk which needs only a c0 header,
+// so the c0c3 cache should be (SRS_PERF_MW_MSGS * 16)
+//
+// @remark, SRS will try another loop when c0c3 cache dry, for we cannot realloc it.
+//       so we use larger c0c3 cache, that is (SRS_PERF_MW_MSGS * 32)
 #define SRS_CONSTS_C0C3_HEADERS_MAX (SRS_PERF_MW_MSGS * 32)

 ///////////////////////////////////////////////////////////
@ -127,16 +117,16 @@
 #define SRS_CONSTS_NULL_FILE "/dev/null"
 #define SRS_CONSTS_LOCALHOST "127.0.0.1"

-// signal defines.
-// reload the config file and apply new config.
+// The signal defines.
+// To reload the config file and apply new config.
 #define SRS_SIGNAL_RELOAD SIGHUP
-// reopen the log file.
+// Reopen the log file.
 #define SRS_SIGNAL_REOPEN_LOG SIGUSR1
-// srs should gracefully quit, do dispose then exit.
+// The signal for srs to gracefully quit, do dispose then exit.
 #define SRS_SIGNAL_GRACEFULLY_QUIT SIGTERM

-// application level signals.
-// persistence the config in memory to config file.
+// The application level signals.
+// Persistence the config in memory to config file.
 // @see https://github.com/ossrs/srs/issues/319#issuecomment-134993922
 // @remark we actually don't handle the signal for it's not a valid os signal.
 #define SRS_SIGNAL_PERSISTENCE_CONFIG 1000
@ -149,33 +139,33 @@
 ///////////////////////////////////////////////////////////

 ///////////////////////////////////////////////////////////
-// log consts values
+// The log consts values
 ///////////////////////////////////////////////////////////
-// downloading speed-up, play to edge, ingest from origin
+// Downloading speed-up, play to edge, ingest from origin
 #define SRS_CONSTS_LOG_EDGE_PLAY "EIG"
-// uploading speed-up, publish to edge, foward to origin
+// Uploading speed-up, publish to edge, foward to origin
 #define SRS_CONSTS_LOG_EDGE_PUBLISH "EFW"
-// edge/origin forwarder.
+// The edge/origin forwarder.
 #define SRS_CONSTS_LOG_FOWARDER "FWR"
-// play stream on edge/origin.
+// Play stream on edge/origin.
 #define SRS_CONSTS_LOG_PLAY "PLA"
-// client publish to edge/origin
+// Client publish to edge/origin
 #define SRS_CONSTS_LOG_CLIENT_PUBLISH "CPB"
-// web/flash publish to edge/origin
+// The web/flash publish to edge/origin
 #define SRS_CONSTS_LOG_WEB_PUBLISH "WPB"
-// ingester for edge(play)/origin
+// Ingester for edge(play)/origin
 #define SRS_CONSTS_LOG_INGESTER "IGS"
-// hls log id.
+// The hls log id.
 #define SRS_CONSTS_LOG_HLS "HLS"
-// encoder log id.
+// The encoder log id.
 #define SRS_CONSTS_LOG_ENCODER "ENC"
-// http stream log id.
+// The http stream log id.
 #define SRS_CONSTS_LOG_HTTP_STREAM "HTS"
-// http stream cache log id.
+// The http stream cache log id.
 #define SRS_CONSTS_LOG_HTTP_STREAM_CACHE "HTC"
-// stream caster log id.
+// The stream caster log id.
 #define SRS_CONSTS_LOG_STREAM_CASTER "SCS"
-// the nginx exec log id.
+// The nginx exec log id.
 #define SRS_CONSTS_LOG_EXEC "EXE"

 ///////////////////////////////////////////////////////////
@ -213,14 +203,14 @@
 ///////////////////////////////////////////////////////////
 // HTTP consts values
 ///////////////////////////////////////////////////////////
-// the default http port.
+// The default http port.
 #define SRS_CONSTS_HTTP_DEFAULT_PORT 80
-// linux path seprator
+// The linux path seprator
 #define SRS_CONSTS_HTTP_PATH_SEP '/'
-// query string seprator
+// Query string seprator
 #define SRS_CONSTS_HTTP_QUERY_SEP '?'

-// the default recv timeout.
+// The default recv timeout.
 #define SRS_HTTP_RECV_TIMEOUT (60 * SRS_UTIME_SECONDS)

 // 6.1.1 Status Code and Reason Phrase
@ -405,7 +395,7 @@
 ///////////////////////////////////////////////////////////
 #define SRS_CONSTS_KAFKA_DEFAULT_PORT 9092

-// the common io timeout, for both recv and send.
+// The common io timeout, for both recv and send.
 #define SRS_CONSTS_KAFKA_TIMEOUT (30 * SRS_UTIME_MILLISECONDS)

 #endif