mirror of
https://github.com/ossrs/srs.git
synced 2025-03-09 15:49:59 +00:00
For #299, refine code.
This commit is contained in:
winlin
parent
62b7204514
commit
f32aab3d92
175 changed files with 15529 additions and 15935 deletions
|
|
@ -1,33 +1,29 @@
|
|||
/*
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2013-2017 SRS(ossrs)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
/**
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2013-2017 SRS(ossrs)
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to
|
||||
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
* the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef SRS_PROTOCOL_STREAM_HPP
|
||||
#define SRS_PROTOCOL_STREAM_HPP
|
||||
|
||||
/*
|
||||
#include <srs_protocol_stream.hpp>
|
||||
*/
|
||||
|
||||
#include <srs_core.hpp>
|
||||
|
||||
#include <srs_protocol_io.hpp>
|
||||
|
|
@ -36,11 +32,11 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
||||
#ifdef SRS_PERF_MERGED_READ
|
||||
/**
|
||||
* to improve read performance, merge some packets then read,
|
||||
* when it on and read small bytes, we sleep to wait more data.,
|
||||
* that is, we merge some data to read together.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
*/
|
||||
* to improve read performance, merge some packets then read,
|
||||
* when it on and read small bytes, we sleep to wait more data.,
|
||||
* that is, we merge some data to read together.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
*/
|
||||
class IMergeReadHandler
|
||||
{
|
||||
public:
|
||||
|
|
@ -48,24 +44,24 @@ public:
|
|||
virtual ~IMergeReadHandler();
|
||||
public:
|
||||
/**
|
||||
* when read from channel, notice the merge handler to sleep for
|
||||
* some small bytes.
|
||||
* @remark, it only for server-side, client srs-librtmp just ignore.
|
||||
*/
|
||||
* when read from channel, notice the merge handler to sleep for
|
||||
* some small bytes.
|
||||
* @remark, it only for server-side, client srs-librtmp just ignore.
|
||||
*/
|
||||
virtual void on_read(ssize_t nread) = 0;
|
||||
};
|
||||
#endif
|
||||
|
||||
/**
|
||||
* the buffer provices bytes cache for protocol. generally,
|
||||
* protocol recv data from socket, put into buffer, decode to RTMP message.
|
||||
* Usage:
|
||||
* ISrsReader* r = ......;
|
||||
* SrsFastStream* fb = ......;
|
||||
* fb->grow(r, 1024);
|
||||
* char* header = fb->read_slice(100);
|
||||
* char* payload = fb->read_payload(924);
|
||||
*/
|
||||
* the buffer provices bytes cache for protocol. generally,
|
||||
* protocol recv data from socket, put into buffer, decode to RTMP message.
|
||||
* Usage:
|
||||
* ISrsReader* r = ......;
|
||||
* SrsFastStream* fb = ......;
|
||||
* fb->grow(r, 1024);
|
||||
* char* header = fb->read_slice(100);
|
||||
* char* payload = fb->read_payload(924);
|
||||
*/
|
||||
// TODO: FIXME: add utest for it.
|
||||
class SrsFastStream
|
||||
{
|
||||
|
|
@ -92,64 +88,64 @@ public:
|
|||
virtual ~SrsFastStream();
|
||||
public:
|
||||
/**
|
||||
* get the size of current bytes in buffer.
|
||||
*/
|
||||
* get the size of current bytes in buffer.
|
||||
*/
|
||||
virtual int size();
|
||||
/**
|
||||
* get the current bytes in buffer.
|
||||
* @remark user should use read_slice() if possible,
|
||||
* the bytes() is used to test bytes, for example, to detect the bytes schema.
|
||||
*/
|
||||
* get the current bytes in buffer.
|
||||
* @remark user should use read_slice() if possible,
|
||||
* the bytes() is used to test bytes, for example, to detect the bytes schema.
|
||||
*/
|
||||
virtual char* bytes();
|
||||
/**
|
||||
* create buffer with specifeid size.
|
||||
* @param buffer the size of buffer. ignore when smaller than SRS_MAX_SOCKET_BUFFER.
|
||||
* @remark when MR(SRS_PERF_MERGED_READ) disabled, always set to 8K.
|
||||
* @remark when buffer changed, the previous ptr maybe invalid.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
*/
|
||||
* create buffer with specifeid size.
|
||||
* @param buffer the size of buffer. ignore when smaller than SRS_MAX_SOCKET_BUFFER.
|
||||
* @remark when MR(SRS_PERF_MERGED_READ) disabled, always set to 8K.
|
||||
* @remark when buffer changed, the previous ptr maybe invalid.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
*/
|
||||
virtual void set_buffer(int buffer_size);
|
||||
public:
|
||||
/**
|
||||
* read 1byte from buffer, move to next bytes.
|
||||
* @remark assert buffer already grow(1).
|
||||
*/
|
||||
* read 1byte from buffer, move to next bytes.
|
||||
* @remark assert buffer already grow(1).
|
||||
*/
|
||||
virtual char read_1byte();
|
||||
/**
|
||||
* read a slice in size bytes, move to next bytes.
|
||||
* user can use this char* ptr directly, and should never free it.
|
||||
* @remark user can use the returned ptr util grow(size),
|
||||
* for the ptr returned maybe invalid after grow(x).
|
||||
*/
|
||||
* read a slice in size bytes, move to next bytes.
|
||||
* user can use this char* ptr directly, and should never free it.
|
||||
* @remark user can use the returned ptr util grow(size),
|
||||
* for the ptr returned maybe invalid after grow(x).
|
||||
*/
|
||||
virtual char* read_slice(int size);
|
||||
/**
|
||||
* skip some bytes in buffer.
|
||||
* @param size the bytes to skip. positive to next; negative to previous.
|
||||
* @remark assert buffer already grow(size).
|
||||
* @remark always use read_slice to consume bytes, which will reset for EOF.
|
||||
* while skip never consume bytes.
|
||||
*/
|
||||
* skip some bytes in buffer.
|
||||
* @param size the bytes to skip. positive to next; negative to previous.
|
||||
* @remark assert buffer already grow(size).
|
||||
* @remark always use read_slice to consume bytes, which will reset for EOF.
|
||||
* while skip never consume bytes.
|
||||
*/
|
||||
virtual void skip(int size);
|
||||
public:
|
||||
/**
|
||||
* grow buffer to the required size, loop to read from skt to fill.
|
||||
* @param reader, read more bytes from reader to fill the buffer to required size.
|
||||
* @param required_size, loop to fill to ensure buffer size to required.
|
||||
* @return an int error code, error if required_size negative.
|
||||
* @remark, we actually maybe read more than required_size, maybe 4k for example.
|
||||
*/
|
||||
* grow buffer to the required size, loop to read from skt to fill.
|
||||
* @param reader, read more bytes from reader to fill the buffer to required size.
|
||||
* @param required_size, loop to fill to ensure buffer size to required.
|
||||
* @return an int error code, error if required_size negative.
|
||||
* @remark, we actually maybe read more than required_size, maybe 4k for example.
|
||||
*/
|
||||
virtual int grow(ISrsReader* reader, int required_size);
|
||||
public:
|
||||
#ifdef SRS_PERF_MERGED_READ
|
||||
/**
|
||||
* to improve read performance, merge some packets then read,
|
||||
* when it on and read small bytes, we sleep to wait more data.,
|
||||
* that is, we merge some data to read together.
|
||||
* @param v true to ename merged read.
|
||||
* @param handler the handler when merge read is enabled.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
* @remark the merged read is optional, ignore if not specifies.
|
||||
*/
|
||||
* to improve read performance, merge some packets then read,
|
||||
* when it on and read small bytes, we sleep to wait more data.,
|
||||
* that is, we merge some data to read together.
|
||||
* @param v true to ename merged read.
|
||||
* @param handler the handler when merge read is enabled.
|
||||
* @see https://github.com/ossrs/srs/issues/241
|
||||
* @remark the merged read is optional, ignore if not specifies.
|
||||
*/
|
||||
virtual void set_merge_read(bool v, IMergeReadHandler* handler);
|
||||
#endif
|
||||
};
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue