srs/trunk/src/app/srs_app_pithy_print.hpp
Winlin 23d2602c34
UniquePtr: Support SrsUniquePtr to replace SrsAutoFree. v6.0.136 (#4109)
To manage an object:

```cpp
// Before
MyClass* ptr = new MyClass();
SrsAutoFree(MyClass, ptr);
ptr->do_something();

// Now
SrsUniquePtr<MyClass> ptr(new MyClass());
ptr->do_something();
```

To manage an array of objects:

```cpp
// Before
char* ptr = new char[10];
SrsAutoFreeA(char, ptr);
ptr[0] = 0xf;

// Now
SrsUniquePtr<char[]> ptr(new char[10]);
ptr[0] = 0xf;
```

In fact, SrsUniquePtr is a limited subset of SrsAutoFree, mainly
managing pointers and arrays. SrsUniquePtr is better than SrsAutoFree
because it has the same API to standard unique ptr.

```cpp
SrsUniquePtr<MyClass> ptr(new MyClass());
ptr->do_something();
MyClass* p = ptr.get();
```

SrsAutoFree actually uses a pointer to a pointer, so it can be set to
NULL, allowing the pointer's value to be changed later (this usage is
different from SrsUniquePtr).

```cpp
// OK to free ptr correctly.
MyClass* ptr;
SrsAutoFree(MyClass, ptr);
ptr = new MyClass();

// Crash because ptr is an invalid pointer.
MyClass* ptr;
SrsUniquePtr<MyClass> ptr(ptr);
ptr = new MyClass();
```

Additionally, SrsAutoFreeH can use specific release functions, which
SrsUniquePtr does not support.

---------

Co-authored-by: Jacob Su <suzp1984@gmail.com>
2024-07-09 10:29:36 +08:00

152 lines
4.3 KiB
C++

//
// Copyright (c) 2013-2024 The SRS Authors
//
// SPDX-License-Identifier: MIT
//
#ifndef SRS_APP_PITHY_PRINT_HPP
#define SRS_APP_PITHY_PRINT_HPP
#include <srs_core.hpp>
#include <map>
#include <srs_app_reload.hpp>
// The stage info to calc the age.
class SrsStageInfo : public ISrsReloadHandler
{
public:
int stage_id;
srs_utime_t interval;
int nb_clients;
// The number of call of can_print().
uint32_t nn_count;
// The ratio for interval, 1.0 means no change.
double interval_ratio;
public:
srs_utime_t age;
public:
SrsStageInfo(int _stage_id, double ratio = 1.0);
virtual ~SrsStageInfo();
virtual void update_print_time();
public:
virtual void elapse(srs_utime_t diff);
virtual bool can_print();
public:
virtual srs_error_t on_reload_pithy_print();
};
// The manager for stages, it's used for a single client stage.
// Of course, we can add the multiple user support, which is SrsPithyPrint.
class SrsStageManager
{
private:
std::map<int, SrsStageInfo*> stages;
public:
SrsStageManager();
virtual ~SrsStageManager();
public:
// Fetch a stage, create one if not exists.
SrsStageInfo* fetch_or_create(int stage_id, bool* pnew = NULL);
};
// The error pithy print is a single client stage manager, each stage only has one client.
// For example, we use it for error pithy print for each UDP packet processing.
class SrsErrorPithyPrint
{
public:
// The number of call of can_print().
uint32_t nn_count;
private:
double ratio_;
SrsStageManager stages;
std::map<int, srs_utime_t> ticks;
public:
SrsErrorPithyPrint(double ratio = 1.0);
virtual ~SrsErrorPithyPrint();
public:
// Whether specified stage is ready for print.
bool can_print(srs_error_t err, uint32_t* pnn = NULL);
// We also support int error code.
bool can_print(int err, uint32_t* pnn = NULL);
};
// An standalone pithy print, without shared stages.
class SrsAlonePithyPrint
{
private:
SrsStageInfo info_;
srs_utime_t previous_tick_;
public:
SrsAlonePithyPrint();
virtual ~SrsAlonePithyPrint();
public:
virtual void elapse();
virtual bool can_print();
};
// The stage is used for a collection of object to do print,
// the print time in a stage is constant and not changed,
// that is, we always got one message to print every specified time.
//
// For example, stage #1 for all play clients, print time is 3s,
// if there is 1client, it will print every 3s.
// if there is 10clients, random select one to print every 3s.
// Usage:
// SrsUniquePtr<SrsPithyPrint> pprint(SrsPithyPrint::create_rtmp_play());
// while (true) {
// pprint->elapse();
// if (pprint->can_print()) {
// // print pithy message.
// // user can get the elapse time by: pprint->age()
// }
// // read and write RTMP messages.
// }
class SrsPithyPrint
{
private:
int client_id;
SrsStageInfo* cache_;
int stage_id;
srs_utime_t _age;
srs_utime_t previous_tick;
private:
SrsPithyPrint(int _stage_id);
public:
static SrsPithyPrint* create_rtmp_play();
static SrsPithyPrint* create_rtmp_publish();
static SrsPithyPrint* create_hls();
static SrsPithyPrint* create_forwarder();
static SrsPithyPrint* create_encoder();
static SrsPithyPrint* create_exec();
static SrsPithyPrint* create_ingester();
static SrsPithyPrint* create_edge();
static SrsPithyPrint* create_caster();
static SrsPithyPrint* create_http_stream();
static SrsPithyPrint* create_http_stream_cache();
static SrsPithyPrint* create_rtc_play();
// For RTC sender and receiver, we create printer for each fd.
static SrsPithyPrint* create_rtc_send(int fd);
static SrsPithyPrint* create_rtc_recv(int fd);
#ifdef SRS_SRT
static SrsPithyPrint* create_srt_play();
static SrsPithyPrint* create_srt_publish();
#endif
virtual ~SrsPithyPrint();
private:
// Enter the specified stage, return the client id.
virtual int enter_stage();
// Leave the specified stage, release the client id.
virtual void leave_stage();
public:
// Auto calc the elapse time
virtual void elapse();
// Whether current client can print.
virtual bool can_print();
// Get the elapsed time in srs_utime_t.
virtual srs_utime_t age();
};
#endif