Использование shared_ptr в качестве выходного параметра

Question

Я работаю над C++ API, который экспортирует несколько классов из DLL.

интерфейс общественного класса А должен соблюдать следующие условные обозначения:

• Все функции возвращают код ошибки.
• Выходные параметры используются для дополнительных возвращаемых значений.
• Проход по указателю используется для выходных параметров.
• Ссылка на константу используется для входных параметров (передается по значению для примитивных типов).
• Когда клиент должен взять на себя ответственность за выходной параметр shared_ptr, в противном случае обычный указатель.

Пример интерфейса: использование

typedef std::shared_ptr<Object> ObjectPtr; 

class APIClass 
{ 
    ErrorCode SetSomething(int i); 
    ErrorCode IsSomethingSet(bool* ask); 
    ErrorCode DoSomething(); 
    ErrorCode GetSomething(ObjectPtr* outObj); 
} 

Пример: реализация

ErrorCode res; 
ObjectPtr obj; 
res = myApiClass->GetSomething(&obj); 

GetSomething:

ErrorCode APIClass::GetSomething(ObjectPtr* outObj) 
{ 
    ObjectPtr temp(new Object(), CleanUpFunction<Object>); 

    // Do something with object temp. 
    ... 

    *outObj= temp; 

    return OK; 
} 

ли сохранить использовать shared_ptr таким образом или возможно есть проблемы, о которых я должен знать?

Answer 1

Это прекрасно, но я бы спросил, действительно ли необходим общий указатель в этом случае. В основном потому, что вы не можете освободить указатель от shared_ptr любым разумным способом ... это может привести к проблемам позже. И shared_ptr действительно означает неопределенное или совместное владение базовым ресурсом.

Я обычно документируют функцию и использовать что-то вроде:

// Caller must delete the outObj once done. 
ErrorCode APIClass::GetSomething(Object* & outObj) 
{ 
    // I use auto_ptr so I can release it later... 
    // Mostly I hate auto_ptr, but for this its invaluable. 

    auto_ptr<Object> obj(new Object); 
    ... 
    outObj = obj.release(); 
    return OK; 
} 

Это так, как это до клиента, что они хотят, чтобы хранить указатель в, и ясно, что право собственности на объект переходит к вызывающий абонент.

Клиентский код может затем использовать соответствующий контейнер.

Object * obj_raw; 
ErrorCode ec = apiClass.GetSomething(obj_raw) 
if(ec!=OK) { .. do something with ec .. } 
shared_ptr<Object> obj(obj_raw); 

или

auto_ptr<Object> obj(obj_raw); 

или

scoped_ptr<Object> obj(obj_raw); 

т.д.

Обратите внимание, что это может быть сделано аккуратнее, если вы измените определение функции для:

// Caller must delete the return value. 
// On error, NULL is returned and e filled in appropriately. 
Object* APIClass::GetSomething(ErrorCode & e) 
{ 
    auto_ptr<Object> obj(new Object); 
    .. 
    e = OK; 
    return obj.release(); 
} 

//Now using it looks like this: 
ErrorCode ec; 
shared_ptr<Object> obj(apiObject.GetSomething(ec)); 
if(!obj) 
{ 
    .. do something with ec .. 
}