| synopsis || return value || arguments || prev || next |

kdu_client::post_window

virtual bool post_window( kdu_window * window)

[Declared in "../apps/compressed_io/kdu_client.h"]

Go to class description.


Synopsis

Requests that a message be delivered to the server identifying a change in the user's window of interest into the compressed image. The message may not be delivered immediately; it may not even be delivered at all, if the function is called again specifying a different access window, before the function has a chance to deliver a request for the current window to the server.

It is important to note that the server may not be able to serve some windows in the exact form they are requested. When this happens, the server's response will indicate modified attributes of the window which it is able to service. The client may learn about the actual window for which data is being served by calling get_window_in_progress.

This function may be called at any time after connect, without necessarily waiting for open to succeed. In fact, this can be useful, since it allows an initial window to be requested while the initial transfer of mandatory headers is in progress, or even before it starts, thereby avoiding the latency associated with extra round-trip-times.


Return Value

False if the specified window is known to have been fully served already, so that it will not result in any request being delivered to the server. If the function returns true, the window is held until a suitable request message can be sent to the server. This message will eventually be sent, unless a new call to post_window arrives in the mean time.

Arguments

window [kdu_window *]


| top || synopsis || return value || arguments || prev || next |