![]() |
Oyranos Color Management System API |
A filter connection structure. More...
#include <oyFilterSocket_s.h>
Public Member Functions | |
OYAPI oyFilterSocket_s *OYEXPORT | oyFilterSocket_New (oyObject_s object) |
allocate a new FilterSocket object More... | |
OYAPI oyFilterSocket_s *OYEXPORT | oyFilterSocket_Copy (oyFilterSocket_s *filtersocket, oyObject_s object) |
copy or reference a FilterSocket object More... | |
OYAPI int OYEXPORT | oyFilterSocket_Release (oyFilterSocket_s **filtersocket) |
release and possibly deallocate a oyFilterSocket_s object More... | |
OYAPI int OYEXPORT | oyFilterSocket_Callback (oyFilterPlug_s *c, oyCONNECTOR_EVENT_e e) |
Tell about a oyConversion_s event. More... | |
OYAPI int OYEXPORT | oyFilterSocket_SignalToGraph (oyFilterSocket_s *c, oyCONNECTOR_EVENT_e e) |
Send a signal through the graph. More... | |
OYAPI oyFilterNode_s *OYEXPORT | oyFilterSocket_GetNode (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::node. More... | |
OYAPI oyStruct_s *OYEXPORT | oyFilterSocket_GetData (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::data. More... | |
OYAPI int OYEXPORT | oyFilterSocket_SetData (oyFilterSocket_s *socket, oyStruct_s *data) |
Set oyFilterSocket_s::data. More... | |
OYAPI oyFilterPlugs_s *OYEXPORT | oyFilterSocket_GetPlugs (oyFilterSocket_s *socket) |
Access oyFilterSocket_s::requesting_plugs_. More... | |
OYAPI const char *OYEXPORT | oyFilterSocket_GetRelatives (oyFilterSocket_s *socket) |
get short description of belonging filter More... | |
![]() | |
const char * | oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get object infos from a module More... | |
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get a text dump More... | |
Data Fields | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
![]() | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
A filter connection structure.
The passive output version of a oyConnector_s.
OYAPI int OYEXPORT oyFilterSocket_Callback | ( | oyFilterPlug_s * | c, |
oyCONNECTOR_EVENT_e | e | ||
) |
Tell about a oyConversion_s event.
Function oyFilterSocket_Callback
[in,out] | c | the connector |
e | the event type |
References oyCONNECTOR_EVENT_OK.
Referenced by oyFilterNode_s::oyFilterNode_Disconnect(), and oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket().
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_Copy | ( | oyFilterSocket_s * | filtersocket, |
oyObject_s | object | ||
) |
copy or reference a FilterSocket object
Function oyFilterSocket_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | filtersocket | FilterSocket struct object |
object | NULL - means reference, the optional object triggers a real copy |
References oyOBJECT_FILTER_SOCKET_S.
Referenced by oyFilterNode_s::oyFilterNode_GetSocket(), and oyFilterPlug_s::oyFilterPlug_GetSocket().
OYAPI oyStruct_s *OYEXPORT oyFilterSocket_GetData | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::data.
Function oyFilterSocket_GetData
[in] | socket | the socket |
References copy, and oyOBJECT_FILTER_SOCKET_S.
Referenced by oyFilterGraph_s::oyFilterGraph_ToText().
OYAPI oyFilterNode_s *OYEXPORT oyFilterSocket_GetNode | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::node.
Function oyFilterSocket_GetNode
[in] | socket | the socket |
References oyFilterNode_s::oyFilterNode_Copy(), and oyOBJECT_FILTER_SOCKET_S.
Referenced by oyFilterPlug_s::oyFilterPlug_GetRemoteNode().
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterSocket_GetPlugs | ( | oyFilterSocket_s * | socket | ) |
Access oyFilterSocket_s::requesting_plugs_.
Function oyFilterSocket_GetPlugs
[in] | socket | the socket |
References oyFilterPlugs_s::oyFilterPlugs_Copy(), and oyOBJECT_FILTER_SOCKET_S.
OYAPI const char *OYEXPORT oyFilterSocket_GetRelatives | ( | oyFilterSocket_s * | socket | ) |
get short description of belonging filter
Function oyFilterSocket_GetRelatives
[in] | socket | the socket |
References oyOBJECT_FILTER_SOCKET_S.
OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_New | ( | oyObject_s | object | ) |
allocate a new FilterSocket object
Function oyFilterSocket_New
References oyOBJECT_OBJECT_S.
Referenced by oyFilterNode_s::oyFilterNode_GetSocket().
OYAPI int OYEXPORT oyFilterSocket_Release | ( | oyFilterSocket_s ** | filtersocket | ) |
release and possibly deallocate a oyFilterSocket_s object
Function oyFilterSocket_Release
[in,out] | filtersocket | FilterSocket struct object |
References oyOBJECT_FILTER_SOCKET_S.
Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch(), oyFilterNode_s::oyFilterNode_Disconnect(), oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_SetData(), and oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket().
OYAPI int OYEXPORT oyFilterSocket_SetData | ( | oyFilterSocket_s * | socket, |
oyStruct_s * | data | ||
) |
Set oyFilterSocket_s::data.
Function oyFilterSocket_SetData
[in] | socket | the socket |
[in] | data | the data |
References oyStruct_s::copy, and oyOBJECT_FILTER_SOCKET_S.
OYAPI int OYEXPORT oyFilterSocket_SignalToGraph | ( | oyFilterSocket_s * | c, |
oyCONNECTOR_EVENT_e | e | ||
) |
Send a signal through the graph.
Function oyFilterSocket_SignalToGraph
The traversal direction is defined as from the starting node to the output.
< kind of ping
< connection established
< released the connection
< call to update image views
< new data accessors
< can not process image
< can not handle option
< can not handle profile
< can not completely process
oyStruct_Copy_f oyFilterSocket_s::copy |
Copy function.
Referenced by oyFilterSocket_GetData().
oyObject_s oyFilterSocket_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyFilterSocket_s::release |
Release function.
Referenced by oyFilterNode_s::oyFilterNode_SetData().
const oyOBJECT_e oyFilterSocket_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.