Oyranos Color Management System API - Version 0.9.6
Public Member Functions | Data Fields
oyFilterSocket_s Struct Reference

A filter connection structure. More...

#include <oyFilterSocket_s.h>

Inheritance diagram for oyFilterSocket_s:
Inheritance graph
Collaboration diagram for oyFilterSocket_s:
Collaboration graph

Public Member Functions

OYAPI oyFilterSocket_s *OYEXPORT oyFilterSocket_New (oyObject_s object)
 allocate a new FilterSocket object
 oyFilterSocket_Copy
 Copy or Reference a FilterSocket object.
OYAPI int OYEXPORT oyFilterSocket_Release (oyFilterSocket_s **filtersocket)
 release and possibly deallocate a oyFilterSocket_s object
OYAPI int OYEXPORT oyFilterSocket_Callback (oyFilterPlug_s *c, oyCONNECTOR_EVENT_e e)
 Tell about a oyConversion_s event.
OYAPI int OYEXPORT oyFilterSocket_SignalToGraph (oyFilterSocket_s *c, oyCONNECTOR_EVENT_e e)
 Send a signal through the graph.
OYAPI oyFilterNode_s *OYEXPORT oyFilterSocket_GetNode (oyFilterSocket_s *socket)
 Access oyFilterSocket_s::node.
OYAPI oyStruct_s *OYEXPORT oyFilterSocket_GetData (oyFilterSocket_s *socket)
 Access oyFilterSocket_s::data.
OYAPI int OYEXPORT oyFilterSocket_SetData (oyFilterSocket_s *socket, oyStruct_s *data)
 Set oyFilterSocket_s::data.
OYAPI oyFilterPlugs_s *OYEXPORT oyFilterSocket_GetPlugs (oyFilterSocket_s *socket)
 Access oyFilterSocket_s::requesting_plugs_.
OYAPI const char *OYEXPORT oyFilterSocket_GetRelatives (oyFilterSocket_s *socket)
 get short description of belonging filter
- Public Member Functions inherited from oyStruct_s
const char * oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get object infos from a module
const char * oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 Get a text dump.
 oyStruct_RegisterStaticMessageFunc
 register a function for verbosity
 oyStruct_GetInfo
 get a additional string from a object
const char * oyStructTypeToText (oyOBJECT_e type)
 Objects type to small string.

Data Fields

const oyOBJECT_e type_
 Type of object.
oyStruct_Copy_f copy
 Copy function.
oyStruct_Release_f release
 Release function.
oyObject_s oy_
 Oyranos internal object.
- Data Fields inherited from oyStruct_s
const oyOBJECT_e type_
 Type of object.
oyStruct_Copy_f copy
 Copy function.
oyStruct_Release_f release
 Release function.
oyObject_s oy_
 Oyranos internal object.

Detailed Description

A filter connection structure.

The passive output version of a oyConnector_s.

dot_inline_dotgraph_17.png
Version
Oyranos: 0.1.8
Since
2008/07/29 (Oyranos: 0.1.8)
Date
2008/07/29
Examples:
oyranos_cmm_oJPG.c.

Member Function Documentation

OYAPI int OYEXPORT oyFilterSocket_Callback ( oyFilterPlug_s c,
oyCONNECTOR_EVENT_e  e 
)

Tell about a oyConversion_s event.

Function oyFilterSocket_Callback

Parameters
[in,out]cthe connector
ethe event type
Returns
0 on success, else error
Version
Oyranos: 0.1.8
Since
2008/07/28 (Oyranos: 0.1.8)
Date
2009/02/19

References oyFilterPlug_s::oy_, oyCONNECTOR_EVENT_OK, oyCONNECTOR_EVENT_RELEASED, oyFilterPlug_s::oyFilterPlug_Release(), oyFilterPlugs_s::oyFilterPlugs_Count(), oyFilterPlugs_s::oyFilterPlugs_Get(), oyFilterPlugs_s::oyFilterPlugs_ReleaseAt(), and oyObject_GetId().

Referenced by oyFilterNode_s::oyFilterNode_Disconnect(), oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), and oyFilterSocket_SignalToGraph().

oyFilterSocket_Copy

Copy or Reference a FilterSocket object.

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters
[in]filtersocketFilterSocket struct object
objectNULL - means reference, the optional object triggers a real copy
Examples:
oyranos_cmm_oJPG.c.

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

Parameters
[in]socketthe socket
Returns
the data
Version
Oyranos: 0.5.0
Date
2012/10/11
Since
2012/09/23 (Oyranos: 0.5.0)
Examples:
oyranos_cmm_oJPG.c.

References copy, oyOBJECT_FILTER_SOCKET_S, and oyStruct_s::oyStructTypeToText().

Referenced by oyFilterGraph_s::oyFilterGraph_ToText().

OYAPI oyFilterNode_s *OYEXPORT oyFilterSocket_GetNode ( oyFilterSocket_s socket)

Access oyFilterSocket_s::node.

Function oyFilterSocket_GetNode

Parameters
[in]socketthe socket
Returns
the node
Version
Oyranos: 0.5.0
Since
2012/09/05 (Oyranos: 0.5.0)
Date
2012/09/05
Examples:
oyranos_cmm_oJPG.c.

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

Parameters
[in]socketthe socket
Returns
the requesting plugs
Version
Oyranos: 0.5.0
Since
2012/09/05 (Oyranos: 0.5.0)
Date
2012/09/05

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

Parameters
[in]socketthe socket
Returns
short text
Version
Oyranos: 0.5.0
Since
2012/09/05 (Oyranos: 0.5.0)
Date
2012/09/05

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)
OYAPI int OYEXPORT oyFilterSocket_SetData ( oyFilterSocket_s socket,
oyStruct_s data 
)

Set oyFilterSocket_s::data.

Function oyFilterSocket_SetData

Parameters
[in]socketthe socket
[in]datathe data
Returns
error
Version
Oyranos: 0.5.0
Since
2012/09/25 (Oyranos: 0.5.0)
Date
2012/09/25
Examples:
oyranos_cmm_oJPG.c.

References oyStruct_s::copy, oyOBJECT_FILTER_SOCKET_S, oyStruct_s::oyStructTypeToText(), and release.

OYAPI int OYEXPORT oyFilterSocket_SignalToGraph ( oyFilterSocket_s c,
oyCONNECTOR_EVENT_e  e 
)

Field Documentation

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.

Referenced by oyFilterGraph_s::oyFilterGraph_ToText(), and oyFilterSocket_SignalToGraph().

oyStruct_Release_f oyFilterSocket_s::release
const oyOBJECT_e oyFilterSocket_s::type_

Type of object.

The struct type tells Oyranos how to interprete hidden fields.