Instruction set reference
HIPE_OP_FIFO_DROP_PEER
In a client-host relationship, this instruction is used when a client wishes to tell a host that access to the FIFO resource will no longer be required (for example, the user has closed a certain document that was being accessed through the resource).
In the normal use case, the client would send this instruction to location 0 (to be picked up by the parent frame), and the parent frame on receiving the instruction should pass it on to the corresponding host frame.
- location: Sending a message: A value of 0 (corresponding to the body element of the client frame) means the message should be sent to the direct parent of this client. A location corresponding to a child frame means send the message to the client connected to that frame. Receiving a message: A value of 0 (corresponding to body element) means the message came from the direct parent of this frame. A location value corresponding to a child frame means the message came from that client.
- arg[0]: The FIFO resource ID string that was provided to the client when the resource was made available through a HIPE_OP_FIFO_RESPONSE message.
Notes
Either end of the peer relationship can initiate terminating the FIFO relationship, however the host is the end responsible for actually deleting the shared FIFO resource on disk. Whichever end initiates dropping the peer should send this instruction via the framing manager to the opposite end of the relationship.
After receiving this message, the FIFO-host should discard and clean up the shared FIFO resource. (Or if the host is the initator of the drop peer request, it should delete the FIFO resource at the same time as it sends the message to the client.
After this instruction is sent, it should be assumed that the peer relationship no longer exists and no further instructions referencing that that particular FIFO resource should be sent through hipe.