How to: Execute Asynchronous Data Service Queries (WCF Data Services)
By using the WCF Data Services client library, you can asynchronously perform client-server operations, such as executing queries and saving changes. For more information, see Asynchronous Operations (WCF Data Services).
Note: |
|---|
| In an application where the callback must be invoked on a specific thread, you must explicitly marshal the execution of the EndExecute method. For more information, see Asynchronous Operations (WCF Data Services). |
The example in this topic uses the Northwind sample data service and autogenerated client data service classes. This service and the client data classes are created when you complete the WCF Data Services quickstart.
Example
The following example shows how to execute an asynchronous query by calling the BeginExecute method to start the query. The inline delegate calls the EndExecute method to display the query results.
Visual Basic
Public Shared Sub BeginExecuteCustomersQuery() ' Create the DataServiceContext using the service URI. Dim context = New NorthwindEntities(svcUri) ' Define the delegate to callback into the process Dim callback As AsyncCallback = AddressOf OnCustomersQueryComplete ' Define the query to execute asynchronously that returns ' all customers with their respective orders. Dim query As DataServiceQuery(Of Customer) = _ context.Customers.Expand("Orders") Try ' Begin query execution, supplying a method to handle the response ' and the original query object to maintain state in the callback. query.BeginExecute(callback, query) Catch ex As DataServiceQueryException Throw New ApplicationException( _ "An error occurred during query execution.", ex) End Try End Sub ' Handle the query callback. Private Shared Sub OnCustomersQueryComplete(ByVal result As IAsyncResult) ' Get the original query from the result. Dim query As DataServiceQuery(Of Customer) = _ CType(result.AsyncState, DataServiceQuery(Of Customer)) ' Complete the query execution. For Each customer As Customer In query.EndExecute(result) Console.WriteLine("Customer Name: {0}", customer.CompanyName) For Each order As Order In customer.Orders Console.WriteLine("Order #: {0} - Freight $: {1}", _ order.OrderID, order.Freight) Next Next End Sub
C#
public static void BeginExecuteCustomersQuery() { // Create the DataServiceContext using the service URI. NorthwindEntities context = new NorthwindEntities(svcUri); // Define the query to execute asynchronously that returns // all customers with their respective orders. DataServiceQuery<Customer> query = (DataServiceQuery<Customer>)(from cust in context.Customers.Expand("Orders") where cust.CustomerID == "ALFKI" select cust); try { // Begin query execution, supplying a method to handle the response // and the original query object to maintain state in the callback. query.BeginExecute(OnCustomersQueryComplete, query); } catch (DataServiceQueryException ex) { throw new ApplicationException( "An error occurred during query execution.", ex); } } // Handle the query callback. private static void OnCustomersQueryComplete(IAsyncResult result) { // Get the original query from the result. DataServiceQuery<Customer> query = result as DataServiceQuery<Customer>; foreach (Customer customer in query.EndExecute(result)) { Console.WriteLine("Customer Name: {0}", customer.CompanyName); foreach (Order order in customer.Orders) { Console.WriteLine("Order #: {0} - Freight $: {1}", order.OrderID, order.Freight); } } }
See Also
Community Content
RahulMisra2000
Unprofessional
It is a shame that you do not point out that you need to switch to the UI thread inside the callback, if you want to access the UI controls.
Otherwise, you will get invalid thread access message. This is so fundamental to Silverlight, unless you are using
WCF RIA or silverlight enabled wcf service.
Otherwise, you will get invalid thread access message. This is so fundamental to Silverlight, unless you are using
WCF RIA or silverlight enabled wcf service.
Kurt Huebner
Thanks
Tuomo,
Thanks for the fix. I was struggling with this code until I read your comments.
Kurt Huebner
Thanks for the fix. I was struggling with this code until I read your comments.
Kurt Huebner
Note: