Skip to content

Headers

hololinked.server.zmq.message.RequestHeader

Bases: Struct

Header of a request message.

Source code in repo/hololinked/hololinked/server/zmq/message.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
class RequestHeader(msgspec.Struct):
    """Header of a request message."""

    messageType: str
    messageID: str
    senderID: str
    receiverID: str
    serverExecutionContext: SchedulerExecutionContext = msgspec.field(
        default_factory=lambda: default_scheduler_execution_context
    )
    thingExecutionContext: ThingExecutionContext = msgspec.field(
        default_factory=lambda: default_thing_execution_context
    )
    thingID: str | None = ""
    objekt: str | None = ""
    operation: str | None = ""
    payloadContentType: str | None = "application/json"
    preencodedPayloadContentType: str | None = "text/plain"

    def __getitem__(self, key: str) -> Any:
        try:
            return getattr(self, key)
        except AttributeError:
            raise KeyError(f"key {key} not found in {self.__class__.__name__}") from None

    def json(self):
        """
        The header as a dictionary of its fields.

        Returns
        -------
        header: dict[str, Any]
            the header fields keyed by their names
        """
        return {f: getattr(self, f) for f in self.__struct_fields__}

Functions

json 

json()

The header as a dictionary of its fields.

Returns:

Name Type Description
header dict[str, Any]

the header fields keyed by their names
Source code in repo/hololinked/hololinked/server/zmq/message.py 
90
91
92
93
94
95
96
97
98
99
def json(self):
    """
    The header as a dictionary of its fields.

    Returns
    -------
    header: dict[str, Any]
        the header fields keyed by their names
    """
    return {f: getattr(self, f) for f in self.__struct_fields__}

hololinked.server.zmq.message.ResponseHeader

Bases: Struct

Header of a response message.

Source code in repo/hololinked/hololinked/server/zmq/message.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
class ResponseHeader(msgspec.Struct):
    """Header of a response message."""

    messageType: str
    messageID: str
    receiverID: str
    senderID: str
    payloadContentType: str | None = "application/json"
    preencodedPayloadContentType: str | None = ""

    def __getitem__(self, key: str) -> Any:
        try:
            return getattr(self, key)
        except AttributeError:
            raise KeyError(f"key {key} not found in {self.__class__.__name__}") from None

    def json(self):
        """
        The header as a dictionary of its fields.

        Returns
        -------
        header: dict[str, Any]
            the header fields keyed by their names
        """
        return {f: getattr(self, f) for f in self.__struct_fields__}

Functions

json 

json()

The header as a dictionary of its fields.

Returns:

Name Type Description
header dict[str, Any]

the header fields keyed by their names
Source code in repo/hololinked/hololinked/server/zmq/message.py 
118
119
120
121
122
123
124
125
126
127
def json(self):
    """
    The header as a dictionary of its fields.

    Returns
    -------
    header: dict[str, Any]
        the header fields keyed by their names
    """
    return {f: getattr(self, f) for f in self.__struct_fields__}

hololinked.server.zmq.message.EventHeader

Bases: Struct

Header of an event message.

Source code in repo/hololinked/hololinked/server/zmq/message.py 
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
class EventHeader(msgspec.Struct):
    """Header of an event message."""

    messageType: str
    messageID: str
    senderID: str
    eventID: str
    payloadContentType: str | None = "application/json"
    preencodedPayloadContentType: str | None = ""

    def __getitem__(self, key: str) -> Any:
        try:
            return getattr(self, key)
        except AttributeError:
            raise KeyError(f"key {key} not found in {self.__class__.__name__}") from None

    def json(self):
        """
        The header as a dictionary of its fields.

        Returns
        -------
        header: dict[str, Any]
            the header fields keyed by their names
        """
        return {f: getattr(self, f) for f in self.__struct_fields__}

Functions

json 

json()

The header as a dictionary of its fields.

Returns:

Name Type Description
header dict[str, Any]

the header fields keyed by their names
Source code in repo/hololinked/hololinked/server/zmq/message.py 
146
147
148
149
150
151
152
153
154
155
def json(self):
    """
    The header as a dictionary of its fields.

    Returns
    -------
    header: dict[str, Any]
        the header fields keyed by their names
    """
    return {f: getattr(self, f) for f in self.__struct_fields__}